Newer Version Available

This content describes an older version of this product. View Latest

BotVersion

Represents a version of a bot or agent defined by a BotDefinition record. This object is available in API version 63.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field Details
BotDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort
Description

Required. This field relates a bot version to its parent BotDefinition record.

This field is a relationship field.
Relationship Name
BotDefinition
Refers To
BotDefinition
CopilotPrimaryLanguage
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The primary language that the bot or agent communicates in.
CopilotSecondaryLanguages
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description

A comma-separated list of additional languages that the bot or agent supports.

DeveloperName
Type
string
Properties
Filter, Group, Sort
Description

The unique name for this object.

Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Required. Indicates whether the bot version is active or inactive. Only one version for a related BotDefinition can be active at once.
Possible values are:
  • Active
  • Inactive
The default value is Inactive.
ToneType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Defines the tone of the bot.
Possible values are:
  • Casual
  • Formal
  • Neutral
The default value is Casual.
VersionNumber
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number for this version of the bot or agent.