Skip to main content
POST
Create a new customer

Authorizations

Authorization
string
header
required

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

Path Parameters

business_id
string<biz_string>
required

Body

application/json
name
string
required

The name of the customer

Maximum string length: 255
external_id
string | null

The external ID of the customer

Maximum string length: 255
email
string | null

The email address of the customer

Maximum string length: 255
billing_address
Address · object | null

The billing address of the customer

shipping_address
Address · object | null

The shipping address of the customer

phone_number
string | null

The phone number of the customer

Maximum string length: 32

Response

Successful Response

data
Customer · object
required