Skip to main content
PATCH
/
customers
/
{id}
Update a customer
curl --request PATCH \
  --url https://commerce1.on-hellgate.dev/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "email": "<string>",
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "email": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Account-ID
string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

Path Parameters

​
id
string
required

Customer ID

Body

application/json

Body

​
address
AddressSchema · object
​
description
string
​
email
string
​
name
string
​
tax_settings
TaxSettingsSchema · object

Response

Success

​
id
string<uuid>
required
​
name
string
required
​
address
AddressSchema · object
​
description
string
​
email
string
​
tax_settings
TaxSettingsSchema · object