Skip to main content
POST
Create Customer

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Body

application/json
email
string
required

The customer's email.

Example:

"buyer@example.com"

newsletter
boolean

Whether the customer opted into the newsletter. Only send true if the customer actually consented; a subscribed customer can be targeted by your email campaigns and automations. A customer who unsubscribed themselves stays unsubscribed.

Example:

null

newsletter_at
string

When the customer opted in, if you are importing an existing consent. Defaults to now. Cannot be in the future.

Example:

null

Response

200 - undefined