Skip to main content

Create a new contact list

POST 
/api/partner-gateway/v1/contacts/list

Creates a new empty contact list in your account. A contact list is a named group that acts as a recipient audience for campaigns. You must provide at least a name for the list. After creating the list, populate it by adding contacts using POST /contacts/list/contacts (for existing contacts) or by importing contacts from a file with POST /contacts/upload or POST /contacts/upload/vcard (which can auto-assign imported contacts to the list). You can then assign the list to one or more campaigns by including its ID in the contactListIds field when creating or updating a campaign. Set the isTest flag to true if this list is intended for testing purposes only (e.g., sending test messages to internal recipients before launching a real campaign). Returns 201 with the created contact list details including the generated list ID. Returns 400 if the request body is missing required fields or contains invalid data. Returns 500 if an unexpected server error occurs.

Request​

Responses​

Contact list created successfully

Last updated on