Settings

Retrieves all settings information about the Chat deployment that’s associated with your chat session. The Settings request is required as the first request to establish a chat visitor’s session.

This resource is available in API versions 29.0 and later.

https://HOSTNAME/chat/rest/Visitor/Settings

Where HOSTNAME is a variable.

JSON

GET

X-LIVEAGENT-API-VERSION

None

org_id

The ID of the Salesforce organization that's associated with the Live Agent deployment.

deployment_id

The ID of the Chat deployment that the chat request was initiated from.

Settings.buttonIds

An array of chat button IDs for which to retrieve settings information.

Settings.needEstimatedWaitTime

Indicates whether the estimatedWaitTime property should be filled. Specify a value of 1 to request the estimated wait time.

Settings.updateBreadcrumb

Indicates whether to update the chat visitor's location with the URL of the Web page that the visitor is viewing.

None

Settings response