Create a customer

Required scopes:

  • customer.create

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The customer's phone number in international format without '+' prefix.

string

Store id associated to the customer. This field is required when reference_store_slug is not present. The public_id of an existing record in the stores table.

string
required

The store slug where the customer is created.

string | null

Customer valid email. Must be a valid email address.

string | null
tags
array of strings or null

Array of tags.

tags
boolean | null

Set to true if the user has optin for commercial sms.

boolean | null

Set to true if the user has optin for commercial email.

integer | null

Number of points to add to the customer.

string | null

Customer first name.

string | null

Customer last name.

string | null
enum

Customer gender. Possible values are "man", "woman", "undisclosed" and "other".

Allowed:
string | null

Customer birthday in format YYYY-MM-DD. Must be a valid date in the format Y-m-d. Must be a date before 2026-04-23.

string | null

Customer secret 4 digits PIN. Must match the regex /^\d{4}$/. Must be at least 4 characters. Must not be greater than 4 characters.

string | null

Hash of the new customer payment method. Must not be one of unknown.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json