Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json

Request payload

first_name

First name of customer

last_name

Last name of customer

email

Email of customer

phone

Phone number of customer

account_id

A unique Account Id for customer. If empty, one is generated by the system

external_id

A unique External Id for customer that is used to identify them in external systems

notes

Note for customer

metadata
object | null

Can hold JSON object of arbitrary structure

default_address_attributes
object | null
customer_notes_attributes
(object | null)[] | null
metafields_attributes
(object | null)[] | null

Metafields for custom data storage

Response

string | number | boolean | null | any[] | object

Created

Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract.