Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
Minimum string length: 1
emoji
string
properties
object
doubleOptInEnabled
boolean
doubleOptInFrom
string | null
doubleOptInSubject
string
doubleOptInContent
string
variables
string[]

Response

200 - application/json

Create a new contact book

id
string
required

The ID of the contact book

Example:

"clx1234567890"

name
string
required

The name of the contact book

Example:

"Newsletter Subscribers"

teamId
number
required

The ID of the team

Example:

1

properties
object
required

Custom properties for the contact book

Example:
variables
string[]
required

Allowed personalization variables for contacts in this book

Example:
emoji
string
required

The emoji associated with the contact book

Example:

"📙"

createdAt
string
required

The creation timestamp

updatedAt
string
required

The last update timestamp

doubleOptInEnabled
boolean

Whether double opt-in is enabled for new contacts

Example:

true

doubleOptInFrom
string | null

From address used for double opt-in emails (must use a verified domain)

Example:

"Newsletter <[email protected]>"

doubleOptInSubject
string | null

Subject line used for double opt-in confirmation email

Example:

"Please confirm your subscription"

doubleOptInContent
string | null

Email editor JSON content used for double opt-in confirmation

_count
object