Skip to main content
POST
Create Customer
Returns 422 with limit_reached if you’ve reached your plan’s customer limit.

Authorizations

Authorization
string
header
required

Your API key. Create one under Setup → Developer API Keys and select the permissions this endpoint needs.

Scopes

contacts:write

Body

application/json
first_name
string
required

First name.

Maximum string length: 100
phone
string
required

Phone number with country code, for example 919876543210. A leading + is allowed. Must be unique in your workspace.

Maximum string length: 20
Pattern: ^\+?[1-9]\d{6,14}$
last_name
string | null

Last name.

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

Email address.

Maximum string length: 255
type
enum<string> | null

lead, customer or guest. Defaults to lead.

Available options:
guest,
lead,
customer
contact_status_id
integer | null

A customer status ID. If empty, your default status is used.

contact_source_id
integer | null

A customer source ID. If empty, your first source is used.

is_active
boolean | null

false to mark the customer inactive.

group_ids
integer[] | null

Customer group IDs this customer belongs to.

Must reference an existing contact_groups record.

label_ids
integer[] | null

Customer tag IDs on this customer.

Must reference an existing contact_labels record.

custom_fields
object | null

Values for your customer fields.

display_name
string | null

The name shown in your inbox.

Maximum string length: 255

Response

201 Created

data
object