Skip to main content
PUT
Upsert customer

Authorizations

x-api-key
string
header
required

API key issued during onboarding. Every request must supply a valid x-api-key header.

Path Parameters

id
string
required

Customer identifier supplied by the partner system. Must be unique within your account. Leading and trailing whitespace is trimmed.

Minimum string length: 1

Body

application/json

Full replacement of the customer's optional fields. On update, any field that is omitted, null, or an empty string is cleared. Values are trimmed of leading and trailing whitespace.

name
string | null

Customer name. Omit, null, or empty string leaves it unset (and clears an existing value).

phone_number
string | null

Customer phone number. Omit, null, or empty string leaves it unset (and clears an existing value).

email
string | null

Customer email address. Omit, null, or empty string leaves it unset (and clears an existing value).

Response

Customer updated.

data
object
required