Live Agent REST API Developer Guide
jNewer Version Available
Settings
Retrieves all settings information about
the Live Agent deployment that’s associated with your chat session.
The Settings request
is required as the first request to establish a chat visitor’s
session.
Syntax
- URI
- https://hostname/chat/rest/Visitor/Settings
- Available since release
- This resource is available in API versions 29.0 and later.
- Formats
- JSON
- HTTP methods
- GET
- Request headers
- X-LIVEAGENT-API-VERSION
- Request parameters
- None
- Query parameters
-
- org_id
- The ID of the Salesforce organization that’s associated with the Live Agent deployment
- deployment_id
- The ID of theLive Agent deployment that the chat request was initiated from
- Settings.buttonIds
- An array of chat button IDs for which to retrieve settings information
- Settings.updateBreadcrumb
- Indicates whether to update the chat visitor’s location with the URL of the Web page that the visitor is viewing
- Request body
- None
- Response body
- Settings response