v4
latestOpenAPI 3.1.02026-08-031873791.4 MBCustomers
Update customer (partial)
Update specific fields on a customer. Send only the fields you want to change — anything you don't send stays as it is. To clear a nullable field, send null.
Example — rename a customer:
{"name": "Acme Holdings, Inc."}
Example — update phone and website together:
{"phone": "555-0199", "website": "https://acme.example"}
Custom fields
Set custom fields by name:
{"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 happen to have two custom fields with the same name, use the id-based shape:
{"custom_fields": [{"field": {"id": 42}, "value": {"custom_field_id": 42, "value": "Acme"}}]}
Omitting custom_fields from the request leaves existing values untouched.
patch/public/v1/customers/{customer_id}/
Path parameters
customer_idinteger required
Request body
Response
OK