Skip to main content
PATCH
Update customer
Updates the customer record for the given external id. Send only the fields you want to change. Omitted top-level fields keep their current values. Use this endpoint to update profile fields, channel consent, and the push device list. To read the full customer object, use get customer.
Requires a Fire spark access token obtained through token exchange.

Path parameters

Request body

Nested delivery_addresses, billing_profiles, devices, and consent objects use the same shapes as get customer.

Device

Request

Response

Returns the updated customer object in data, using the same shape as get customer.

Error responses

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 customer unique identifier in your system

Body

application/json

Partial customer update. Omit fields you do not want to change. When devices is provided, it replaces the full device list. When consent is provided, omitted consent flags keep their current values.

name
string

The full name of the customer

Example:

"John Smith"

gender
enum<string> | null

The gender of the customer

Available options:
MALE,
FEMALE,
OTHER
dob
string<date-time> | null

The date of birth of the customer

document_type
string | null

The document type of the customer

document_number
string | null

The document number of the customer

Maximum string length: 50
country
string | null

The country of the customer

Maximum string length: 100
phone
string | null

The customer's phone number in international format

Example:

"+593 99 123 4567"

delivery_addresses
object[]
Maximum array length: 10
billing_profiles
object[]
Maximum array length: 10
metadata
object

Custom metadata for the customer

Channel consent preferences. Send only the flags you want to change.

devices
object[]

Full list of push devices for the customer. Replaces the existing list when provided. To unregister a device, omit it from this array. Maximum 10 devices.

Maximum array length: 10

Response

Customer updated

data
object

Customer profile returned by Storefront API endpoints. Omits internal fields such as birthday.