Skip to main content
POST
Add a new customer. Also creates a new profile.

Authorizations

Authorization
string
header
required

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

Body

application/json
channel
enum<string>
Available options:
whatsapp
display_id
string

For WhatsApp: phone number in international format without leading "+", special characters and spaces. Must be unique among channel "whatsapp". Will be saved as phone number in profile.

Example:

491521234567

name
string

Name of customer and profile.

Response

200 - application/json

Success

Represents a customer using a messenger service. A person with a phone number registered on WhatsApp is a customer.

id
integer
channel
enum<string>

Type of messenger service.

Available options:
bridge,
whatsapp,
facebook,
widget
display_id
string

An unique identifier within a channel.

Example:

4915223567929

canonical_id
string | null

Additional ID that identifies the customer. Currently used for WhatsApp. In WhatsApp, the display_id is either the phone number or the username. The canonical_id is always the BSUID (see WhatsApp usernames documentation). For other channels, the canonical_id is not used.

Example:

"DE.abc123"

name
string

Name received from channel.

Example:

"John Doe"

username
string | null

Self given username. See WhatsApp usernames.

Example:

"john_doe"

profile
object

Profile data of a customer, without the nested list of other customers on the same profile. Used when embedding a profile inside a customer, to avoid re-embedding the customer itself.

conversations
object[]

Not always included.