Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

customer_id
string
required

Customer Id

Body

application/json
email
string | null
metadata
null | Metadata · object

Additional metadata for the customer

name
string | null
phone_number
string | null
preferred_locale
null | enum<string>

The language of the customer emails, a code from GET /locales. A value replaces the current language, and null removes it. Send this field only to change the language on purpose. With no language, the emails are in English.

Available options:
ar,
ca,
zh,
nl,
en,
fr,
de,
he,
id,
it,
ja,
ka,
ko,
ms,
pl,
pt,
ro,
ru,
es,
sv,
th,
tr

Response

business_id
string
required
created_at
string<date-time>
required
customer_id
string
required
email
string
required
name
string
required
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.

Available options:
ar,
ca,
zh,
nl,
en,
fr,
de,
he,
id,
it,
ja,
ka,
ko,
ms,
pl,
pt,
ro,
ru,
es,
sv,
th,
tr
Last modified on May 28, 2026