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"
}OK
Bad request - The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
Resource not found - Can happen due to resource conflicts. Re-try with exponential backoff. Contact us on [email protected] if the issue persists.
Conflict error, please retry - The request could not be completed due to a conflict with the current state of the target resource, re-try with exponential backoff.
Rate limit exceeded - Too many requests. Contact us on [email protected] for recommended throughput.
Internal Server Error - Please contact blueshift for more information.
Service unavailable, please retry - Bad Gateway, re-try with exponential backoff.
Service unavailable, please retry - Service Unavailable, re-try with exponential backoff.
Service unavailable, please retry - Gateway Timeout, please re-try with exponential backoff.