Skip to main content
POST

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Contact list or segment data
string
required
Name of the contact list (max 200 characters). Must be unique within the project.Maximum length: 200Example: "Newsletter Subscribers"
string
Description of the contact list (max 500 characters).Maximum length: 500Example: "Users who signed up for the weekly newsletter"
string
Type of contact list.Allowed values: list, segmentDefault: "list"Example: "list"
object
Filter criteria for segments. Required when type is segment.
string
ID of the parent contact list (for creating sub-segments).Example: "60d5ec49f1b2c72d9c8b4567"

Response

Contact list created successfully
boolean
Indicates if the request was successfulExample: true
object
The created contact list object