LiveAgentSettings

Represents an organization’s Chat settings, such as whether Chat is enabled.

This type extends Metadata and inherits its fields.

LiveAgentSettings values are stored in the LiveAgent.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

Introduced in API version 28.0.

• Type: boolean
• Required: No
• Introduced: API version 53.0
• Description: Indicates whether the findOrCreate method of the Chat API is enabled for agents (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether Chat is enabled (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether Quick Text is enabled (true) or not (false).

This is a sample Chat settings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<LiveAgentSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableLiveAgent>true</enableLiveAgent>
4</LiveAgentSettings>

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.