Skip to main content
PATCH
/
api
/
canary
/
customers
/
{id}
Update Customer
curl --request PATCH \
  --url http://localhost:3000/api/canary/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "customField": "value",
    "orderId": "12345"
  }
}
'
{
  "statusCode": 400,
  "message": [
    "Invalid input data"
  ],
  "error": "Bad Request"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The unique identifier of the customer

Body

application/json

Customer update details

metadata
object
required

Optional custom metadata

Example:
{
"customField": "value",
"orderId": "12345"
}
email
string

The email address of the customer

name
string

The full name of the customer

Response

Customer updated successfully