Skip to main content
PUT
Update Customer

Update Customer

Updates an existing customer’s information. Only include the fields you want to update.

Request

Path Parameters

string
required
The unique customer ID

Body Parameters

All body parameters are optional. Only include the fields you want to update.
string
Customer email address
string
Customer’s first name
string
Customer’s last name
string
Customer’s phone number
boolean
Marketing opt-in status
array
Array of tags. Accepted by the request but not persisted — a customer record has no tags field.
string
Internal notes about the customer
array
Array of address objects. Only the first address is persisted, and only its flat fields (address1, city, province, country, zip) are stored on the customer record — there is no separate addresses collection.

Response

The response is a bare object keyed by customer containing the updated customer object (the same shape returned by the read endpoints). There is no { success, data } envelope.
object
The updated customer object

Example Response

Errors

Errors are returned as a standard { "errors": { "base": ["..."] } } body with the corresponding HTTP status code.