Skip to main content
POST
Create a customer list
The new list is empty. Add people to it with Add a contact.
  • Duplicates: leave allowDuplication out, or send false, to reject a phone number that’s already in the list.
  • Variants: add a variant for every custom variable your agent’s script uses. See Variants. Slugs can’t be changed through the API afterwards.
Common causes of a 422 validation error:
  • name is missing, empty or longer than 100 characters.
  • An item in variants is missing slug or name, or has one empty.

Authorizations

X-API-KEY
string
header
required

Body

application/json
name
string
required

The list's name.

Required string length: 1 - 100
Example:

"September renewals"

allowDuplication
boolean

Whether the list accepts a phone number more than once. Leave it out, or send false, to reject duplicates (it's then stored as null, which means no).

Example:

false

variants
object[]

Custom columns. See Variants.

Response

The new customer list.

message
string
Example:

"Customer created successfully"

data
object