Sign in
Agent End User Sessions

Create anonymous visitor

Mints the anonymous identity a widget visitor presents as X-Visitor-Id on /v2/agent_aliases/{alias_key}/end_user_sessions requests, naming a connector in the session create body. No credential is required. The X-Customer-Id header carries the customer_id served by the public connector view; the minted id is scoped to that customer and authenticates the same visitor on any of the customer's widgets that admit anonymous visitors.

Call this only when the client holds no visitor id. The id never expires — store it durably; it is the only proof of ownership of the sessions it creates, and a repeat call mints a fresh identity that owns none of the previous identity's sessions.

Returns 404 when the customer does not exist, is disabled, or has no enabled widget connector that admits anonymous visitors — one indistinguishable refusal, so the endpoint confirms nothing about which customer ids exist.

post/v2/visitors

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

X-Customer-Idinteger required
Example:1234567890

The unique identifier of the customer to mint a visitor identity for, as served by the public connector view.

Response

The minted anonymous visitor identity.

visitor_idstring required

The anonymous identity minted for this visitor, presented as the X-Visitor-Id header on every end-user session request. Scoped to the customer, not the minting widget: it authenticates the same visitor on any of the customer's widgets that admit anonymous visitors. Store it durably on the client; it never expires, and it is the only proof of ownership of the sessions it creates.

Example response

{
  "visitor_id": "vis_lZzE1YTgtNDA1Ni00MmU3LWI5YzMtZTQ4ZDQxN2I5ZTcw"
}

Changes