Skip to main content
POST
Update customer
Required scopes: customers:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
id
string
required

The customer ID. The UUID v4 format is required.

name
string

The customer's name.

email
string

The customer's email.

suggested_email
string | null

The email address suggested for the customer based on tracked activity, such as a form submission. The customer has not confirmed this address. This field is independent of email. An empty value clears only the suggestion.

avatar
string

The URL of the customer's avatar.

phone_number
string

The customer's phone number in E.164 format.

session_fields
object[]

An array of custom object-enclosed key-value pairs. Respects the order of items.

omnichannel
object

The customer's omnichannel data.

address

The customer's address. Provide an empty string to clear it.

Response

200

Customer updated.