Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

LiveAgentSettings

Represents an organization’s Chat settings, such as whether Chat is enabled. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

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.

Version

LiveAgentSettings is available in API version 28.0 and later.

Fields

Field Name	Field Type	Description
enableChatFindOrCreateEnable	boolean	Indicates whether the `findOrCreate` method of the Chat API is enabled for agents (`true`) or not (`false`). Available in API version 53.0 and later.
enableLiveAgent	boolean	Indicates whether Chat is enabled (`true`) or not (`false`).
enableQuickTextEnabled	boolean	Indicates whether Quick Text is enabled (`true`) or not (`false`).
priority	integer	Indicates the priority level of a Chat.

Declarative Metadata Sample Definition

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>

Wildcard Support in the Manifest File

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.

Metadata API Developer Guide