Metadata API

Metadata API includes new and changed types and fields.

New Metadata Types

Audience
Represents the audience in a community. An audience consists of different types of criteria, where the audience can be assigned and used for targeting in a community.
LightningExperienceTheme
Represents the details of a custom theme, including the BrandingSet. Themes enable admins to specify configurable attributes, such as three colors and five images. The colors and some of the images override SLDS token values and influence the generation of app.css.
OmniChannelSettings
Represents the Omni-Channel settings for an org.
PresenceDeclineReason
Represents an Omni-Channel decline reason that agents can select when declining work requests.
PresenceUserConfig
Represents a configuration that determines a presence user’s settings.
QueueRoutingConfig
Represents the settings that determine how work items are routed to agents.
ServiceChannel
Represents a channel of work items that are received from your organization—for example, cases, chats, or leads.
ServicePresenceStatus
Represents a presence status that can be assigned to a service channel.

Updated Metadata Types and Fields

These metadata types have fields that have been added or changed.

Bot
This field is new.
botMlDomain
Represents the intent set that groups intents, entities, and variables associated with a bot. All Einstein Bot versions now share a single bot intent set.
BotVersion
These fields have been removed in API version 44.0 and later.
apexClass
Einstein Bot dialog actions now support Apex, Flows, and Send Email. The apexClass field has been replaced by invocationActionType and invocationActionName.
botVariable
Name of the Bot Variable that is used as part of an Invocation Mapping.
field
API Name of an SObject Field to be used as part of the operand.
leftOperandBotVariable
Name of the bot variable that is used as the left side of the condition operation.
LocalMlDomain
All Einstein Bot versions now share a single bot intent set, so this field is no longer needed.
operandType
No longer needed.
sobjectType
No longer needed.
value
No longer needed.
These fields are new.
conversationVariables
A conversationVariables is a container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.
invocationActionName
The name of the action.
invocationActionType
The type of Action element to add in a bot dialog.
leftOperandName
Required. Name of the variable used as the left side of the condition operation.
leftOperandType
Type of the variable used as the left side of the condition operation.
sourceName
Name of the source CustomField or MlSlotClass used in the variable operation.
sourceValue
Literal value used as the source for this variable operation.
targetName
Name of the target variable used in the variable operation.
targetType
Type of the target used in the variable operation.
value
Literal value to be assigned to the specified parameter.
variableName
Name of the Bot Variable that is used as part of an Invocation mapping.
variableType
Type of the variable used in this invocation mapping.
CaseSettings
Introduced in API version 42.0, this field has been added to the Metadata API Developer Guide.
enableE2CSourceTracking
Indicates whether Set Case Source to Email is enabled (true) or not (false). After you enable this setting, the Case Source field is updated to Email for all cases that originate from Email-to-Case. Associated emails are marked as Read when the agent opens the case.
CommunityTemplateDefinition
This field has changed.
defaultBrandingSet
This is now a read-only field on this type. You can now implement the field on CommunityThemeDefinition rather than CommunityTemplateDefinition. Existing packages that have set the API version to values 40.0 through 43.0 continue to function normally.
CommunityThemeDefinition
These fields are new.
bundleInfo
This field has been added to support exporting themes.
defaultBrandingSet
This field has been added to maintain functionality previously implemented in CommunityTemplateDefinition.
themeRouteOverride
This field has been added to support exporting themes.
CommunityThemeBundleInfo
This field has been added to support exporting themes.
CommunityThemeRouteOverride
This field has been added to support exporting themes.
ContentAsset
This field is new.
isVisibleByExternalUsers
Indicates whether unauthenticated users can see the asset file (true) or not (false).
CspTrustedSite
This field is new.
context
The context enum determines the scope of the trust for the listed third-party host.
CustomField
This field has changed.
encrypted
The encrypted Boolean field is now available only in versions 34.0 through 43.0.
This field is new.
encryptionScheme
The encryptionScheme enum determines which encryption scheme a field takes. Valid values are None, ProbabilisticEncryption, CaseSensitiveDeterministicEncryption, and CaseInsensitiveDeterministicEncryption.
CustomObject
This field is new.
massQuickActions (SearchLayouts subtype)
The list of actions that you can use to perform mass quick action on records. Use this field to add an existing create or update action.
EmbeddedServiceConfig
This field is new.
embeddedServiceCustomLabels
The embeddedServiceCustomLabels field represents the custom labels used in the Snap-ins deployment.
FlexiPage
These fields have changed.
actionListContext (PlatformActionList subtype)
The PlatformActionListContext enum has a new value, ActionDefinition. This value is reserved for future use.
type (FlexiPageRegion subtype)
The FlexiPageRegionType enum has a new value, Background. This value represents a region for background utility items, which aren’t visible in the UI.
leftValue (UiFormulaCriterion subtype)
This field now accepts the {!$Permission.CustomPermission.permissionName} and {!$Permission.StandardPermission.permissionName} expressions to define component visibility rules based on user permissions.
Flow
This field is new.
status
The status enum represents the activation status of the flow. Valid values are Active, Draft, Obsolete, and InvalidDraft. For more details, see Version Numbers Are Omitted from Flow File Names in the API.
These fields have changed.
actionType (FlowActionCall subtype)
The actionType enum has two new values, assignKnowledgeArticles and publishKnowledgeArticles. Both support mass actions on article list views. assignKnowledgeArticles assigns Knowledge articles, and publishKnowledgeArticles publishes Knowledge articles.
fullName
The fullName field no longer includes the version number, so the flow file name doesn’t have to change with every version. For more details, see Version Numbers Are Omitted from Flow File Names in the API.
ForecastingSettings
This field has changed.
name
The Territory_Model_Name value, where Territory_Model_Name is the name of your active territory model, has been added.
ListView
This field has changed.
filterScope
The FilterScope enum has a new value, MineAndMyGroups. This value indicates that the list view includes records owned by the user running the list view and records assigned to that user's queues. For details, see See Approval Requests Assigned to Your Queues in All Salesforce Experiences.
Network
A new valid value, Configurable, has been added to these fields: changePasswordPageOverrideSetting, forgotPasswordPageOverrideSetting, homePageOverrideSetting, loginPageOverrideSetting, and selfRegProfilePageOverrideSetting. Use to identify a page type for a page override.
We added the verificationTemplate field to represent the email template used to communicate with users when they must identify their identity. For example, when users log in without a password or from a new device, they receive an email with a PIN to confirm their identity.
NetworkBranding
This field is new.
LoginBackgroundImageUrl
Specifies the path to the image URL that appears as the background on the community’s login pages. This URL can be fixed or dynamic. A dynamic URL contains the experience ID parameter, {expid}.
Profile
This field was added, but it’s available in API version 41.0 and later.
categoryGroupVisibilities (ProfileCategoryGroupVisibility subtype)
The categoryGroupVisibilities field indicates which data category groups are visible to users assigned to this profile.
SharingSet
This field has changed.
object
The Campaign, Opportunity, and Order objects are available in beta. To enable Sharing Sets for Campaigns, Opportunities, and Orders in your org, contact Salesforce Customer Support. Specify which object, or all three, you want to use with sharing sets.

Updated CustomObjectTranslation Language Support Information

Updates have been made to the Metadata API Developer Guide appendices that describe CustomObjectTranslation language support. In addition to including the following languages, there are corrections to the field values that each language supports.

Fully Supported Languages
Norwegian, Spanish (Mexico), and Swedish
End-user Languages
Croatian, Portuguese (Portugal), Slovak, and Slovenian

Updated Result Objects

This metadata result object has new fields.

DeployResult
These fields are new for RunTestsResult.
flowCoverage
An array of results from test runs that executed flows.
flowCoverageWarnings
An array of warnings generated by test runs that executed flows.