Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Body

application/json
first_name
string
required

Customer's first name.

Maximum string length: 255
last_name
string
required

Customer's last name.

Maximum string length: 255
phone_number
string
required

Customer's phone number.

Maximum string length: 20
email
string<email> | null

Customer's email address.

Maximum string length: 255
date_of_birth
string<date-time> | null

Customer's date of birth.

gender
enum<string> | null

Customer's gender.

Available options:
male,
female,
other
country_id
integer | null

Customer's country identifier.

identity_number
string | null

Customer's identity number.

job
string | null

Customer's job title.

Maximum string length: 255
address
string | null

Customer's address.

Maximum string length: 1000
default_channel_id
integer | null

The customer's preferred default channel.

user_id
integer | null

Assigned user identifier.

tags
integer[] | null

Tag identifiers to attach to the customer.

A tag ID.

Response

success
string
required
data
CustomerResource · object
required