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

Schema for registering a new customer. For anonymous customers, only id and is_anonymous: true are required. For regular customers, id, name, email, and registration_date are required.

id
string
required

Your customer unique identifier

platforms
string[] | null

Platforms associated with the customer

is_anonymous
boolean
default:false

Set to true to create an anonymous customer. When true, name and email are not required.

name
string

The full name of the customer. Required unless is_anonymous is true.

Example:

"John Smith"

email
string<email>

The email of the customer. Required unless is_anonymous is true.

gender
enum<string> | null

The gender of the customer

Available options:
MALE,
FEMALE
dob
string<date-time> | null

The date of birth of the customer

document_type
string | null

The document type of the customer. If provided, document_number is required.

document_number
string | null

The document number of the customer. If provided, document_type is required.

Maximum string length: 50
country
string | null

The country of the customer

Maximum string length: 100
phone
string | null

The customer's phone number in international format. Required for WhatsApp delivery.

Example:

"+593 99 123 4567"

registration_date
string<date-time>

The date when the customer was registered. Defaults to now.

tags
object

Include your conditions customer tags here

devices
object[]

Customer devices for push notifications

The customer's consent preferences

metadata
object

The metadata of the customer

referral_code
string

Optional referral code if customer was referred

Response

Customer created

data
object