Breadcrumb

Sets a breadcrumb value to the URL of the Web page that the chat visitor is viewing as the visitor chats with an agent. The agent can then see the value of the breadcrumb to determine the page the chat visitor is viewing.

This resource is available in API versions 29.0 and later.

URI 

https://HOSTNAME/chat/rest/Visitor/Breadcrumb

Where HOSTNAME is a variable.

Formats 

JSON

HTTP methods 

POST

Request headers 

X-LIVEAGENT-API-VERSION

Request parameters 

None

Query parameters 

None

Request body 

Breadcrumb request

Response body 

None

Overview
Getting Started with the Chat REST API
Request Headers
Your Message Long Polling Loop
Using Estimated Wait Time Instead of Queue Position for a Chat Session (Beta)
Chat REST API Resources
Create a Chat Session
Create a Chat Visitor Session
Monitor Chat Activity
Customize the Chat Visitors’ Experience
Settings
Availability
Breadcrumb
VisitorId
SensitiveDataRuleTriggered for Agents
SensitiveDataRuleTriggered for Chasitors
Request Bodies for Chat REST API
Response Bodies for Chat REST API
Chat REST API Data Types
Status Codes and Error Responses