Updates a customer profile.
PUT
/v2/customers/{customer_id}
Updates a customer profile.
This endpoint supports sparse updates, so only new or changed fields are required in the request. To add or update a field, specify the new value. To remove a field, specify null
.
To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.
You cannot use this endpoint to change cards on file. To make changes, use the Cards API or Gift Cards API.
The given name (that is, the first name) associated with the customer profile.
The maximum length for this value is 300 characters.
The family name (that is, the last name) associated with the customer profile.
The maximum length for this value is 300 characters.
A business name associated with the customer profile.
The maximum length for this value is 500 characters.
A nickname for the customer profile.
The maximum length for this value is 100 characters.
The email address associated with the customer profile.
The maximum length for this value is 254 characters.
The physical address associated with the customer profile. Only new or changed fields are required in the request.
For maximum length constraints, see Customer addresses. The first_name
and last_name
fields are ignored if they are present in the request.
The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional +
prefix and country code. For more information, see Customer phone numbers.
An optional second ID used to associate the customer profile with an entity in another system.
The maximum length for this value is 100 characters.
The birthday associated with the customer profile, in YYYY-MM-DD
or MM-DD
format. For example, specify 1998-09-21
for September 21, 1998, or 09-21
for September 21. Birthdays are returned in YYYY-MM-DD
format, where YYYY
is the specified birth year or 0000
if a birth year is not specified.
The current version of the customer profile.
As a best practice, you should include this field to enable optimistic concurrency control. For more information, see Update a customer profile.
The tax ID associated with the customer profile. This field is available only for customers of sellers in EU countries or the United Kingdom. For more information, see Customer tax IDs.