update_customer
Update the editable details of a customer record in your Checkout Page account.
Use list_customers first if you need to discover the customer ID by name or email. If the customer ID does not exist, returns a 404 error: "Customer not found".
Only the fields you supply are changed; omitted fields are left as-is. The address and shipping subdocuments use patch semantics — supply only the sub-fields you want to change. Send null for any optional field (or for a whole subdocument) to clear it. The primary email field cannot be cleared.
This tool modifies live data and notifies external systems. Every successful update sends a customer.updated webhook, carrying the full updated customer profile, to each endpoint the merchant has subscribed to that event.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Customer full name. Send `null` to clear. | |
| No | Primary customer email address. Trimmed and lowercased before storage. Cannot be cleared via this endpoint. | ||
| phone | No | Customer phone number. Send `null` to clear. | |
| address | No | Billing address. Patch semantics — only the subfields you supply are changed. Send `null` to clear the whole subdocument. | |
| shipping | No | Shipping details. Patch semantics — only the fields you supply are changed (including nested `shipping.address` subfields). Send `null` to clear the whole subdocument. | |
| customerId | Yes | The ID of the customer to update. Use `list_customers` first if you need to discover the customer ID by name or email. | |
| companyName | No | Customer company name. Send `null` to clear. | |
| billingEmail | No | Billing email address. Can be different from the primary email. Trimmed and lowercased before storage. Send `null` to clear. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes |