Create empty list

post

https://api.getblueshift.com/api/v1/custom_user_lists/create

Use this endpoint to create an empty user list.

Body Params

Specify the details about the custom list.

name

string

required

Specify a name for the list. You can identify the list that you create using this name on the dashboard. Ensure that the name that you specify is unique.

description

string

required

Specify an appropirate description of that provides context on what the list contains.

is_seed_list

integer

Specify if this list is a seed list or not. Specify '0' if this is not a seed list. If it is, specify '1'. A seed list is a list of users -- such as internal users -- who should receive a copy of the message that you send in a campaign. You can choose a seed list in either a one-time or a recurring campaign.

source

string

Specify the source that you want to use to add customers to this list. You can specify either email or customer_id. If you leave this field empty, email is automatically selected for the list.

Responses

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.

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

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.