Skip to main content
PUT
Update customer

Authorizations

X-API-KEY
string
header
required

Path Parameters

customer_id
integer
required

Body

application/json

Partial update payload for PUT /public/customers/{id}/.

Every field is optional: send only the fields you want to change. Unset fields are left untouched on the existing record. This is the partial-update semantic clients expect from a modern REST API.

custom_fields
Custom Fields · object[] | null
name
string | null
unique_id
string | null
Required string length: 1 - 64
email
string | null
address
string | null
country
string | null
phone
string | null
Maximum string length: 64
Pattern: ^[0-9\s\+\-\.\(\)]*$
website
string | null
full_address
AddressSchemaIn · object | null
shipping_address
AddressSchemaIn · object | null

Response

OK

id
integer
required
address
string
required
country
string
required
name
string
required
unique_id
string | null
required
website
string
required
email
string
required
customer_type
string
required
is_active
boolean
required
phone
string
required
record_status
string
required
is_taxable
boolean
required
default_tax_code
string
required
tax_registration_number
string
required
default_currency
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
XCD,
XDR,
XOF,
XPD,
XPF,
XPT,
YER,
ZAR,
ZMW,
ZWL
custom_fields
CustomFieldValuePairOutputSchema · object[]
created_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

updated_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

approval_status
string | null
next_approvers
ApproverDictSchema · object[] | null
rejected_by
RejectedBySchema · object | null

Schema for rejector information including rejection reason.

shipping_address
AddressSchemaIn · object | null
Last modified on July 13, 2026