PATCH
Update Visitor

Overview

Updates the current visitor’s profile — typically to capture a name, email, or phone after a conversation has already started (e.g. the widget’s “leave your email” prompt). The visitor is identified by the SDK token, so no ID is needed in the body.
Auth: the visitor’s SDK token (Authorization: Bearer …). Server-to-server callers can use X-Api-Key + X-Api-Secret and must include external_user_id in the body.

Request Headers

Request Body

string
Visitor display name.
string
Visitor email.
string
Visitor phone number.
string
Required only when authenticating with API keys (identifies which visitor to update).

Example Request

Response

Success (200)

Embed the widget

The widget can collect and submit contact details for you.