Use this endpoint to add a user to a custom list.
API at a glance
Description: This API adds a single user to a custom user list using either their email address or customer ID.
Authentication & testing
Testing the API on this page
How to try it here
- Use your User API Key as the Username (leave Password blank).
- Select the appropriate API endpoint based on your Blueshift region.
- Enter the necessary parameters and click Try It to run the request.
Authentication using Base64 encoding
Note for developers
API requests require authentication using HTTP Basic Authentication with an API key.
The API key serves as the username, while the password field should be left empty.
The format to encode is: your_api_key: (note the trailing colon).
This string must be Base64-encoded and included in the request's Authorization header as follows:
Authorization: Basic encoded_valueYou can generate the encoded value using a trusted Base64 encoder.
Postman collection
Try it with Postman: Explore the API using Blueshift's Postman collection.
Things to know before you start
- List ID required: Obtain the list ID from the Create empty list response or from the Blueshift dashboard.
You can find the list ID in the URL when viewing a custom user list in the Blueshift app. For example, if you open a custom user list in the Blueshift app, its URL looks like https://app.getblueshift.com/dashboard#/app/custom_list/<LIST_ID>/edit.
- Identifier types: Use
emailorcustomer_idto identify the user.
Finding the customer UUID > >You can find the customer UUID in the URL when viewing a customer profile in the Blueshift app. For example, if you open a customer profile in the Blueshift app, its URL looks like
https://app.getblueshift.com/dashboard#/app/customer/<CUSTOMER_UUID>/show/overview.
- Single user: This endpoint adds one user at a time. Use Bulk add users for multiple users.
- Use case: Best for adding individual users to custom lists, updating list membership, and managing targeted audience segments.
Request parameters
Check out the request parameters
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_id | integer | ✅ Yes | ID of the list to add the user to. |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identifier_key | string | ✅ Yes | Identifier type: email or customer_id. |
identifier_value | string | ✅ Yes | Value of the identifier (email address or customer ID). |
Example requests & responses
Add user by email
{
"identifier_key": "email",
"identifier_value": "[email protected]"
}{
"status": "ok"
}Add user by customer ID
{
"identifier_key": "customer_id",
"identifier_value": "CUST-12345"
}{
"status": "ok"
}API error responses
Note
The following error codes are commonly returned by Blueshift APIs. Depending on the specific endpoint, not all may apply.
Status code | Description | Example responses |
|---|---|---|
400 Bad Request | The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data. |
|
401 Unauthorized | API authentication failed due to an invalid or missing API key. |
|
403 Forbidden | The API key does not have sufficient permissions to perform this action. |
|
404 Not Found | The specified campaign was not found. Verify the campaign UUID. |
|
422 Unprocessable Entity |
|
|
429 Too Many Requests | The request limit has been exceeded. Reduce request frequency. |
|
500 Internal Server Error | An unexpected server error occurred. Contact support if the issue persists. |
|
502 Bad Gateway | The server received an invalid response. Retry the request. |
|
503 Service Unavailable | The service is temporarily unavailable. Try again later. |
|
504 Gateway Timeout | The server took too long to respond. Retry the request with exponential backoff. |
|