Update a customer
How to update an existing customer via API
To update an existing customer, send a PATCH
request to the /api/customers/:id
endpoint, where id
is the ID of the resource that you want to update.
Here below the list of all the possible arguments that you can pass with the request body.
Request
PATCH https://yourdomain.commercelayer.io/api/customers/:id
Arguments
type
string
Required
id
string
Required
attributes.email
string
Optional
attributes.password
string
Optional
attributes.shopper_reference
string
Optional
attributes.profile_id
string
Optional
attributes.tax_exemption_code
string
Optional
attributes._add_tags
string
Optional
attributes._remove_tags
string
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes._request_anonymization
boolean
Optional
attributes._cancel_anonymization
boolean
Optional
relationships.customer_group
object
Optional
relationships.tags
array
Optional
Example
The following request updates the customer identified by the ID "xYZkjABcde":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/customers/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "customers",
"id": "xYZkjABcde",
"attributes": {
"password": "secret"
},
"relationships": {
"customer_group": {
"data": {
"type": "customer_groups",
"id": "ABCRtyUpBa"
}
}
}
}
}'
Last updated