DocumentationDeveloper PortalAPI EndpointsProduct Updates
API Endpoints
Contact Us

Bulk remove users from list

put
https://api.getblueshift.com/api/v1/custom_user_lists/bulk_remove_users_from_list/

Use this endpoint to bulk remove users from a custom list.

Path Params
integer
required

Specify the ID of the list from which you want to remove users in bulk.

Body Params

Specify the details of the users that you want to bulk remove from the list.

string
required

Specify the key that you use to identify the users. This field can either take customer_id or email.

identifier_values
array of strings
required

Specify the values of the identifier key. For example, if you specify customer_id in the identifier_key field, specify the users' alphanumeric customer IDs in this field. Such as [abcd1234]. If you specify email in the identifier_key, specify the email address of the users you want to remove from the list. Such as, [[email protected]].

identifier_values*
Responses
200

OK

400

Input params not valid.

404

The list has been deleted.

413

You can add maximum 25 users in one API call.

422

Functionality not supported for old list.

429

Rate limit exceeded - Too many requests

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

Updated 4 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago