Sign in
text-widget-public

Create Widget Session

Create a new text chat session for a widget visitor.

post/api/v1/public/text-widget/sessions

Query parameters

keystring nullable

Headers

X-Widget-Keystring nullable

Request body

visitor_namestring nullable
visitor_emailstring nullable
visitor_phonestring nullable
text_agent_idstring uuid nullable
consent_givenboolean
consent_versionstring nullable

Response

Successful Response

session_idstring uuid required
session_tokenstring required
greeting_messagestring nullable required

Changes

Changed in 1 of the 28 revisions of this API.2

  • d65b8fefae342See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 28 revisions, 1 has no diff computed.