Metadata API

Metadata API includes new and changed types and fields.

New Metadata Types

AccountRelationshipShareRule
Represents the rule that determines which object records are shared, how they are shared, the account relationship type that shares the records, and the level of access granted to the records.
CustomHelpMenuSection
Represents the section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources for the org. The custom section contains help resources added by the admin.
EmbeddedServiceFlowConfig
Represents a setup node for creating a Flow Snap-in.
LightningComponentBundle
Represents a new type of Lightning component called a Lightning web component. A bundle contains Lightning web component resources, like HTML, JavaScript, and CSS files.
The original Lightning components are now called Aura components. The metadata type is still AuraDefinitionBundle.
RecommendationStrategy
Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations.
RecordActionDeployment

Represents a deployment that contains settings for a Guided Action List. A deployment specifies channel defaults and actions that users can add at run time.

PlatformEventChannel
Represents a collection of entities selected for Change Data Capture notifications in the Change Data Capture page in Salesforce. Change Data Capture sends notifications for created, updated, deleted, and undeleted records only for the selected entities.

Updated Metadata Types

These metadata types have changes or have new or changed fields.

Audience
These fields are new or changed.
  • formula—This new field indicates the formula used to determine the audience.
  • formulaFilterType—This field now includes the CustomLogicMatches value.
AudienceCriterion (Audience subtype)
These fields are new or changed.
  • criteriaNumber—This new field indicates the number associated with the criterion in a formula.
  • operator—This field now includes the values Includes and NotIncludes.
  • type—This field now includes the value Permission.
AudienceCriteriaValue (AudienceCriterion subtype)
These fields are new and can be used only when the value of the AudienceCriterion type field is Permission.
  • isEnabled—This field indicates whether the permission is enabled for a user.
  • permissionName—This field indicates the valid API name of a standard user or custom permission.
  • permissionType—This field indicates whether the type of permission is standard or custom.
Bot
These fields are new.
contextVariableMappings (ConversationContextVariable subtype)
Represents the mapping between a context variable, channel type, and sObject field.
contextVariables
Represents the context variables that enable your bot to gather customer information regardless of channel.
dataType (ConversationContextVariable subtype)
Represents the data type of the context variable.
developerName (ConversationContextVariable subtype)
Represents the name of the context variable.
fieldName ConversationContextVariableMapping subtype
The API name of an SObject field to be used as part of the mapping.
label (ConversationContextVariable subtype)
A label that identifies the context variable throughout the Salesforce user interface.
messageType ConversationContextVariableMapping subtype
Represents the channel, either SMS messaging or Live Agent chat.
SObjectType ConversationContextVariableMapping subtype
SObject type for the field property defined as part of the mapping.
BotVersion
These fields are new or changed.
dataType (ConversationVariable subtype)
The new Id value represents an Id data type, for example, Contact Id or User Id.
leftOperandType (BotStepCondition subtype)
The new values ConversationVariable and ContextVariable represent the type of variable used in the bot step condition.
sourceType (BotVariableOperand subtype)
We documented the valid values for this field: StandardConversationVariable, ConversationVariable, ContextVariable, MlSlotClass, StandardMlSlotClass, and Value.
targetType (BotStepCondition subtype)
We added the values ConversationVariable and ContextVariable.
type (BotNavigation subtype)
We removed the EndChat value.
variableType (BotInvocationMapping subtype)
We added the values ConversationVariable and ContextVariable.
CommunityThemeDefinition
The following field is new.
publisher
Defines the name of the publisher as seen in the Community Creation wizard. If no name is provided, this will be the name of the org from which the package was originally exported.
CommunityTemplateDefinition
The following field is new.
publisher
Defines the name of the publisher as seen in the Community Creation wizard. If no name is provided, this will be the name of the org from which the package was originally exported.
CustomField
These fields are new.
businessOwnerGroup (Beta)
Indicates the group associated with this field.
businessOwnerUser (Beta)
Indicates the person associated with this field.
businessStatus (Beta)
Indicates whether the field is in use.
securityClassification (Beta)
Indicates the sensitivity of the data contained in this field.
This field has changed.
customDataType
This field was reserved for future use and is now deprecated to simplify metadata testing and using Tooling API.
EmbeddedServiceConfig
These fields are new.
areGuestUsersAllowed
Specifies whether a user must be logged in to access a Snap-in.
embeddedServiceFlowConfig
Represents a setup node for creating a Snap-in flow.
embeddedServiceFlows
Lists the flows used by the Snap-in deployment.
FlexiPage
These fields have changed.
appendable, replaceable, and prependable (FlexiPageRegion subtype)
We have made these fields available for use in Communities to control the locked and unlocked regions of a FlexiPage.
type
The new CommFlowPage value represents an out-of-the-box flow page available in Communities.
Flow
These fields are new.
isTemplate
Indicates whether the process or flow is a template. When installed from managed packages, processes and flows can’t be viewed or cloned by subscribers because of intellectual property (IP) protection. But when those processes and flows are templates, subscribers can open them in a builder, clone them, and customize the clones.
textTemplates (FlowTranslation subtype)
Contains details for a translation of a text template in a flow. The FlowTextTemplateTranslation is available only in flows created via Salesforce Surveys.
These fields have changed.
processType
The new ContactRequestFlow value lets customers request that customer support get back to them.
actionType (FlowActionCall subtype)
We added these values.
  • archiveKnowledgeArticles—This action archives a list of published Knowledge articles.
  • contactRequestAction—This action creates a contact request record.
  • createDraftFromOnlineKnowledgeArticle—This action creates a draft from a published Knowledge article.
  • restoreKnowledgeArticleVersion—This action restores an archived version of a Knowledge article.
limit (FlowDynamicChoiceSet subtype)
This field is now Nillable.
ForecastingSettings
This field has changed.
name
We added the value Territory_Model_Name_ProductFamily, where Territory_Model_Name is the name of your active territory model.
IoTSettings
Represents the organization’s IoT settings, such as whether or not IoT or IoT Insights is enabled. Introduced in API version 44.0, this type has been added to the Metadata API Developer Guide.
LiveChatAgentConfig
The following fields have been added to the Metadata API Developer Guide.
customAgentName
Specifies the custom name for an agent, if one has been set. Available in API version 29.0 and later.
enableChatMonitoring
Indicates whether chat monitoring is enabled for support supervisors. Available in API version 29.0 and later.
enableChatTransferToAgent
Indicates whether agents can transfer a chat to another agent.. Available in API version 36.0 and later.
enableChatTransferToButton
Indicates whether agents can transfer a chat to a button. Available in API version 36.0 and later.
enableChatTransferToSkill
Indicates whether agents can transfer a chat to a skill group. Available in API version 36.0 and later.
enableWhisperMessage
Indicates whether support supervisors can send whisper messages to agents during a chat.. Available in API version 29.0 and later.
LiveMessageSettings
Represents an org’s LiveMessage settings. Introduced in API version 42.0, this type has been added to the Metadata API Developer Guide.
MacroSettings
This field has changed.
macrosInFolders
This field, introduced in API version 44.0, indicates whether users can organize and share macros using folders. The MacroSettings type has been added to the Metadata API Developer Guide.
Network
This field is new.
enableMemberVisibility
Controls community user visibility on a per-community basis. If true, the Community User Visibility preference is enabled for the selected community.
ProfileActionOverride
Beginning with API version 45.0, this metadata type can’t be defined on Profile. Instead, access ProfileActionOverride from the encompassing CustomApplication. Home page assignments related to user profile must now also have a corresponding app assignment because more granular Home page assignments are supported. As a result, ProfileActionOverride is defined for CustomApplication rather than Profile.
Queue
This field has changed.
sobjectType
The new ContactRequestvalue lets you create a queue for contact requests.
SharingSet
These fields have changed.
object
The Campaign, Opportunity, and Order values are generally available.
userField
The Contact.RelatedAccount User value is generally available.
QuickAction
This field has changed.
standardLabel
The new ScheduleAppointment value lets customers schedule appointments using Lightning Scheduler.