Metadata API

Metadata API includes new and changed types and fields.

New Metadata Types

EmailServicesFunction
Represents an email service.
EmbeddedServiceBranding
Represents the branding for each Snap-ins deployment. Introduced in API version 39.0, this type has been added to the Metadata API Developer Guide.
EmbeddedServiceConfig
Represents a setup node for creating a Snap-ins deployment. Introduced in API version 37.0, this type has been added to the Metadata API Developer Guide.
EmbeddedServiceLiveAgent
Represents a setup node for creating a Snap-ins Chat Live Agent deployment. Introduced in API version 38.0, this type has been added to the Metadata API Developer Guide.

Updated Metadata Types and Fields

These metadata types have changed or have fields that are new or have changed.

ActionOverride
The formFactor field now supports the Small value, which represents the Salesforce mobile app on a phone or tablet.
ActivitySettings
The autoRelateEventAttendees field lets admins set events to automatically relate up to 50 contacts or one lead when users invite the contacts or lead to the event.
CompactLayout
Represents a compact layout. This type is now available for external objects.
CustomApplication
This type was reorganized to consolidate fields into logical groupings to make it easier to use only the fields you need.
The following fields are new.
consoleConfig
Represents configuration settings for a Salesforce console app.
preferences
Represents the preferences for a Salesforce console app.
shouldOverrideOrgTheme
Indicates whether to override the global theme for the org.
The following fields have been renamed.
customShortcut (in the KeyboardShortcuts subtype)
This field is now called customShortcuts.
defaultShortcut (in the KeyboardShortcuts subtype)
This field is now called defaultShortcuts.
tab
This field is now called tabs.
workspaceMappings
This field is now called workspaceConfig.
The following subtypes are new.
AppPreferences
This subtype consolidates the preferences for a Salesforce console app.
ServiceCloudConsoleConfig
This subtype consolidates the configuration settings for the Service Cloud console.
The following fields have been moved.
customApplicationComponents
This field is now called componentList and is found in the ServiceCloudConsoleConfig subtype.
detailPageRefreshMethod
This field is now found in the ServiceCloudConsoleConfig subtype.
enableCustomizeMyTabs
This field is now found in the AppPreferences subtype.
enableKeyboardShortcuts
This field is now found in the AppPreferences subtype.
enableListViewHover
This field is now found in the AppPreferences subtype.
enableListViewReskin
This field is now found in the AppPreferences subtype.
enableMultiMonitorComponents
This field is now found in the AppPreferences subtype.
enablePinTabs
This field is now found in the AppPreferences subtype.
enableTabHover
This field is now found in the AppPreferences subtype.
enableTabLimits
This field is now found in the AppPreferences subtype.
footerColor
This field is now found in the ServiceCloudConsoleConfig subtype.
headerColor
This field is now found in the ServiceCloudConsoleConfig subtype.
keyboardShortcuts
This field is now found in the ServiceCloudConsoleConfig subtype.
listPlacement
This field is now found in the ServiceCloudConsoleConfig subtype.
listRefreshMethod
This field is now found in the ServiceCloudConsoleConfig subtype.
liveAgentConfig
This field is now found in the ServiceCloudConsoleConfig subtype.
primaryTabColor
This field is now found in the ServiceCloudConsoleConfig subtype.
pushNotifications
This field is now found in the ServiceCloudConsoleConfig subtype.
saveUserSessions
This field is now found in the AppPreferences subtype.
tabLimitConfig
This field is now found in the ServiceCloudConsoleConfig subtype.
The following subtypes have been deleted.
DomainWhitelist
This subtype is no longer used.
PagesToOpen
This subtype is no longer used.
PushNotifications
This subtype is no longer used.
The following subtypes have been replaced.
CustomApplicationComponents
The AppComponentList subtype replaces this subtype.
WorkspaceMappings
The AppWorkspaceConfig subtype replaces this subtype.
CustomObject
The following fields have changed.
compactLayoutAssignment
Represents the compact layout assigned to the object. This field is now available for external objects.
compactLayouts
A list of compact layouts associated with the object. This field is now available for external objects.
CustomObjectTranslation
The following field has been added.
description
Translation for the record type description.
Dashboard
The following fields have been added.
breakPoint1
The value that separates the lowRangeColor from the midRangeColor on the dashboard.
breakPoint2
The value that separates the midRangeColor from the highRangeColor on the dashboard.
breakPointOrder
Conditional highlighting can be applied to multiple columns. This field stores the order of conditional highlights.
chartTheme
Determines the default theme for all dashboard charts. This field replaces dashboardChartTheme for API version 42.0 and later. The dashboardChartTheme field is still available for backward compatibility with versions before API version 42.0.
colorPalette
Determines the default palette for all dashboard charts. This field replaces dashboardColorPalette for API version 42.0 and later. The dashboardColorPalette field is still available for backward compatibility with versions before API version 42.0.
flexComponentProperties (Dashboard Component)
Defines metadata for Lightning Experience table columns and sorting.
flexTableColumn (FlowScreen subtype)
Represents a column in a Lightning Experience table component.
flexTableSortInfo
Represents sorting column and order in a Lightning Experience table component.
hideChatterPhotos
If true, hides any photos from Chatter feeds.
highRangeColor
The color representing a high number range on the column.
lowRangeColor
The color representing a low number range on the column.
midRangeColor
The color representing a mid number range on the column.
numSubscriptions
Indicates the number of subscriptions reported on the dashboard.
reportColumn (DashboardComponentColumn subtype)
Indicates the report column code for the filter.
showTotal (DashboardComponentColumn subtype)
If true, the column total is displayed.
sortColumn (DashboardComponentSortInfo subtype)
Indicates the column on which the table is sorted.
sortOrder (DashboardComponentSortInfo subtype)
Indicates the sort order for the table.
type (DashboardComponentColumn subtype)
Represents the type of Lightning Experience table column (details, aggregates, or grouping).
FlexiPage
The following enumeration value has been added to the type field.
CommGlobalSearchResultPage
A Lightning page used to override the global search result page in Communities, as created in Community Builder.
The leftValue field now accepts expressions to help define component visibility rules on Lightning pages. For example, to display a component only to the system administrator, use {!$User.Profile.Name} EQUAL "System Administrator".
Flow
The following fields are new.
extensionName (FlowScreenField subtype)
The name of the Lightning component to display.
inputParameters (FlowScreenField subtype)
An array of input parameters. Supported only when fieldType is ComponentInstance.
outputParameters (FlowScreenField subtype)
An array of output parameters. Supported only when fieldType is ComponentInstance.
showFooter (FlowScreen subtype)
Indicates whether to show (true) or hide (false) the screen’s footer at runtime.
showHeader (FlowScreen subtype)
Indicates whether to show (true) or hide (false) the screen’s header at runtime.
stages
An array of stages that can be used throughout the flow. A stage is a section of your flow that can be represented in the UI, such as with breadcrumbs. Flow stages are a beta feature.
The following fields have been updated.
actionType (FlowActionCall subtype)
The enumerated value choosePricebook is new. This value is used to select a price book.
fieldType (FlowScreenField subtype)
The enumerated value ComponentInstance is new. This value is used for Lightning component screen fields.
Field Types
The following enumeration value has been corrected.
Location
The name of the Location custom field type has been corrected in the Metadata API Developer Guide. The Location field type is used to define geolocation fields in the user interface.
ForecastingSettings
The following field is new.
ForecastingDateType
The date type that forecast amounts are based on in Collaborative Forecasts. Valid values are OpportunityCloseDate (default), ProductDate, and ScheduleDate. In API version 42.0, date types are read only and available only via API.
OrderSettings
The following field was added.
enableZeroQuantity
Indicates whether users in the organization can add order products with quantities of zero (true) or not (false). This has a default value of false.

To enable this preference, enableOrders must be set to true.

Available in API version 42.0 and later.

Layout
The following fields are new.
createAction (SidebarComponent subtype)
If the component is a lookup field, the name of the quick action used to create a record.
enableLinking (SidebarComponent subtype)
If the component is a lookup field, lets users associate a record with this field.
updateAction (SidebarComponent subtype)
If the component is a lookup field, the name of the quick action used to update a record.
Queue
The following fields are new.
publicGroups
Represents public groups in the org. Public groups can be used to add queue members.
queueMembers
Represents queue members added to the queue. Members can be added directly or selected by roles and public groups they belong to.
queueRoutingConfig
Represents the routing configuration name. Applies to orgs that use Omni-Channel with a routing configuration.
roleAndSubordinates
Represents roles and their subordinates in the org’s role hierarchy, including customer and partner roles. Roles and their subordinate hierarchy can be used to add queue members.
roleAndSubordinatesInternal
Represents roles and their subordinates in the org’s role hierarchy, excluding customer and partner roles. Roles and their subordinate hierarchy can be used to add queue members.
roles
Represents roles in the org. Roles can be used to add queue members.
users
Represents users in the org. Users can be added directly as queue members.
SecuritySettings
The following fields are new.
enableContentSniffingProtection
Indicates if the browser is prevented from inferring the MIME type from the document content and from executing malicious files (JavaScript, Stylesheet) as dynamic content.
enableUpgradeInsecureRequests
Indicates if HTTPS is required for connecting to third-party domains.
enableXssProtection
Indicates if protection against reflected cross-site scripting attacks is enabled.
identityConfirmationOnEmailChange
Indicates if a user’s identity is confirmed when changing their email address, instead of requiring a relogin.
identityConfirmationOnTwoFactorRegistrationEnabled
Indicates if users are required to confirm their identities to add a two-factor authentication method, such as Salesforce Authenticator, instead of requiring a relogin.
redirectionWarning
Indicates whether users see an alert when they click a link in a Web Tab that redirects them outside the salesforce.com domain.
referrerPolicy
Indicates whether the referrer header hides sensitive information that could be present in the full URL.