Skip to main content
POST
Add a new contact

Authorizations

Authorization
string
header
required

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

Body

application/json
email
string
required

The email of the contact.

Example:

"john@acme.com"

userId
string | null

The user id of the contact.

Example:

"1234567"

avatarUrl
string | null

The avatar url of the contact.

Example:

"https://example.com/avatar.jpg"

name
string | null

The full name of the contact.

Example:

"John Doe"

languageCode
string | null

The language code of the contact.

Example:

"en_US"

updateIfExists
boolean | null

If a contact with the provided email already exists, update the contact with the new data.

ignoreListSubscriptionsWhenUpdating
boolean | null

Whether to ignore subscribedToLists field if the contact already exists and updateIfExists is set to true. Useful to avoid accidentally resubscribing a contact to lists they unsubscribed before. Default value is true.

subscribedToLists
string[]

The array of mailing lists the contact is subscribed to.

Example:
customProperties
object

The custom properties set for this contact.

Example:

Response

200 - application/json

A created or updated contact

success
boolean
data
object