Update a customer
PATCH
/v1/customers/{id}
Patches top-level fields and/or the custom_fields map. Custom-field values are validated against the active CustomFieldDefinition set — failed keys come back in rejected while siblings still apply.
Authorizations
BearerAuth
API key in the form one_pk_<random>. Mint at /settings/api-keys.
Type
HTTP (bearer)
Parameters
Path Parameters
id*
The customer-profile id (uuid).
Type
Requiredstring
Example
"123"Request Body
application/json
JSON "status": "string", "account_number": "string", "payment_terms": "string", "default_currency": "string", "credit_limit": null, "billing_email": "string", "contact_first_name": "string", "contact_last_name": "string", "contact_email": "string", "contact_phone": "string", "notes": "string", "custom_fields": { "additionalProperties": null }
{
}
Responses
Successful response
application/json
JSON "meta": { "version": 0 }, "data": { "id": "string", "party_id": "string", "name": "string", "status": "string", "account_number": "string", "payment_terms": "string", "default_currency": "string", "credit_limit": "string", "billing_email": "string", "contact_first_name": "string", "contact_last_name": "string", "contact_email": "string", "contact_phone": "string", "notes": "string", "custom_fields": { "additionalProperties": null }, "created_at": "string", "updated_at": "string" }, "changed": [ "string" ], "rejected": { "additionalProperties": "string" }
{
}