Create a contact list

Creates an empty list under a name no other list of yours holds. type decides what the list is for and is fixed for its lifetime: default for a group you send to, blacklist for a suppression set covering the channels in channels. Fill it afterwards with POST /contact-lists/{list_id}/contacts or PUT /contact-lists/{list_id}/contacts/{contact_id}.

Body Params

Contact list to create.

string
required
length between 3 and 120

Name for the list; must not already be taken by one of your lists.

string
enum

What the list is for. Defaults to default and cannot be changed afterwards.

Allowed:
channels
array of objects

Channels a blacklist list suppresses on; duplicates are collapsed. Omit it or send [] on a default list — anything else is rejected with 422.

channels
Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json