Skip to main content
POST
Create customer
Required scopes: customers:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
name
string

Customer name.

email
string

Customer email.

avatar
string

URL of the customer's avatar.

session_fields
object[]

Array of custom object-enclosed key-value pairs. Respects the order of items.

Response

200 - application/json

Customer created.

customer_id
string

Unique identifier of the created customer.