Skip to main content
PATCH
Identify the widget visitor

Authorizations

X-Auth-Token
string
header
required

The signed session token from POST /api/v1/widget/config. Sent alongside website_token in the query string on every widget request. See /api-reference/widget-api-authentication.

Query Parameters

website_token
string
required

The web-widget inbox's public token, as it appears in your widget snippet. Required on every widget request.

Example:

"EXAMPLE_WEBSITE_TOKEN"

Body

application/json
identifier
string
required

Your own identifier for this person.

Example:

"crm-visitor-1"

identifier_hash
string

HMAC-SHA256 of identifier keyed by the inbox HMAC token, computed on your server. Required when the inbox mandates identity verification, and verifying widens what the visitor can see.

name
string

Display name.

email
string

Email address.

phone_number
string

Phone number.

custom_attributes
object

Custom attributes to merge onto the contact.

avatar_url
string

Avatar image URL.

Response

Success

The identified contact.