BotSettings

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

File Suffix and Directory Location

Bot components have the suffix .bot and are stored in the bot folder.

Version

Bot components are available in API version 46.0 and later.

Fields

Field Name	Field Type	Description
enableBots	boolean	Indicates whether Einstein Bots is enabled (`true`) or not (`false`).

Declarative Metadata Sample Definition

The following is an example of a BotSetting. This example has been trimmed to make it easier to read.

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

The following is an example package.xml manifest that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Bot</members>
5        <name>Settings</name>
6    </types>
7    <version>46.0</version>
8</Package>

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