v4

latestOpenAPI 3.1.02026-08-031873791.4 MB
Customers

Update customer

Update a customer. Send only the fields you want to change — anything you don't send stays as it is.

Setting custom fields is easiest using the field name as the key:

{"custom_fields": [{"Partner": true}, {"Tier": "Gold"}]}

Each item is a one-key object where the key is the custom field's name and the value is whatever you want to set. Use null to clear a field. If the name doesn't match a custom field in your organization you'll get a 422 back — we won't silently ignore it.

If you already know the custom field's id, the older nested shape still works and you can mix both in the same request:

{"custom_fields": [{"field": {"id": 42}, "value": {"custom_field_id": 42, "value": "Acme"}}]}

Edge case: if you happen to have two custom fields with the same name, the name-keyed shape can't tell them apart — use the id-based shape for those.

put/public/v1/customers/{customer_id}/

Path parameters

customer_idinteger required

Request body

custom_fieldsobject[] nullable
namestring nullable
unique_idstring nullable
emailstring nullable
addressstring nullable
countrystring nullable
phonestring nullable
websitestring nullable

Response

OK

approval_statusstring nullable
idinteger required
addressstring required
countrystring required
namestring required
unique_idstring nullable required
websitestring required
emailstring required
customer_typestring required
is_activeboolean required
phonestring required
record_statusstring required
is_taxableboolean required
default_tax_codestring required
tax_registration_numberstring required