PATCH

Authorizations

Authorization
string
header
required

The back-office user's id_token — the ID token, not the access_token. The API rejects access tokens.

Path Parameters

customerId
string<uuid>
required

The customer's ID.

Query Parameters

programId
string
required

The program the customer/account belongs to. Required on every request.

Body

application/json

At least one field should be supplied. Only the fields present are updated.

tier
string

New tier for the customer.

Example:

"premium"

phone
string

New phone number in E.164 format.

Example:

"+447700900123"

email
string<email>

New email address.

Example:

"jordan.taylor@example.com"

Response

The customer record was updated.

Standard mutation envelope. Additional fields may be present depending on the operation.

success
boolean
Example:

true