Skip to main content
POST
JavaScript

प्राधिकरण

Authorization
string
header
आवश्यक

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

बॉडी

application/json
email
string
आवश्यक
name
string
आवश्यक
metadata
Metadata · object

Additional metadata for the customer

phone_number
string | null
preferred_locale
null | enum<string>

The language of the customer emails, a code from GET /locales. With no value, the emails are in English until a checkout or the customer portal sets a language.

उपलब्ध विकल्प:
ar,
ca,
zh,
nl,
en,
fr,
de,
he,
id,
it,
ja,
ka,
ko,
ms,
pl,
pt,
ro,
ru,
es,
sv,
th,
tr

प्रतिक्रिया

business_id
string
आवश्यक
created_at
string<date-time>
आवश्यक
customer_id
string
आवश्यक
email
string
आवश्यक
name
string
आवश्यक
blocked_at
string<date-time> | null

When the merchant blocked this customer. The dashboard shows the "Blocked" badge and the unblock action from it. The list route leaves it empty; only the single-customer route resolves it.

blocklist_entry_id
string | null

Blocklist entry behind blocked_at, so the dashboard can link to it.

metadata
Metadata · object

Additional metadata for the customer

phone_number
string | null
preferred_locale
null | enum<string>

The language of the customer emails. null gives English.

उपलब्ध विकल्प:
ar,
ca,
zh,
nl,
en,
fr,
de,
he,
id,
it,
ja,
ka,
ko,
ms,
pl,
pt,
ro,
ru,
es,
sv,
th,
tr
अंतिम संशोधन 1 अप्रैल 2026