Add user to list

put

https://api.getblueshift.com/api/v1/custom_user_lists/add_user_to_list/{list_id}

Use this endpoint to add a user to a custom list.

Path Params

list_id

integer

required

Specify the ID of the custom user list to which you want to add a user. You can find the list ID in the URL when viewing the list in the Blueshift app. For example: https://app.getblueshift.com/dashboard#/app/custom_list/41148/edit - the list ID here is 41148.

Body Params

Specify the details of the user that you want to add to the list.

identifier_key

string

enum

required

Specify how you want to identify the user:

• Use email to identify by email address • Use customer_id to identify by customer ID

This must match the source type configured when the list was created.

Allowed:

identifier_value

string

required

Specify the actual identifier value:

• If identifier_key is email: provide the user's email address (e.g., [email protected]) • If identifier_key is customer_id: provide the customer ID (e.g., 23a1fae1-2103-4e18-b58c-9db0ea9f7bf7)

You can find the customer ID in the URL when viewing a customer profile: https://app.getblueshift.com/dashboard#/app/customer/<CUSTOMER_ID>/show/overview

Responses

200

400

Bad request - The request was invalid or cannot be otherwise served. An accompanying error message will explain further.

404

Resource not found - Can happen due to resource conflicts. Re-try with exponential backoff. Contact us on [email protected] if the issue persists.

409

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.

429

Rate limit exceeded - Too many requests. Contact us on [email protected] for recommended throughput.

500

Internal Server Error - Please contact blueshift for more information.

502

Service unavailable, please retry - Bad Gateway, re-try with exponential backoff.

503

Service unavailable, please retry - Service Unavailable, re-try with exponential backoff.

504

Service unavailable, please retry - Gateway Timeout, please re-try with exponential backoff.

401Unauthorized - API authentication failed due to an invalid or missing API key.

403Forbidden - The API key does not have sufficient permissions to perform this action.

422Unprocessable Entity - The request was well-formed but contains semantic errors.