Metadata API Developer Guide
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
Metadata Components and Types
Metadata Coverage Report
Unsupported Metadata Types
Special Behavior in Metadata API Deployments
Metadata Type Limits
AccountPlanObjMeasCalcDef
AccountRelationshipShareRule
AccountingFieldMapping
AccountingModelConfig
ActionLinkGroupTemplate
ActionPlanTemplate
ActionableListDefinition
AdvAccountForecastSet
AffinityScoreDefinition
AIApplication
AIApplicationConfig
AiAuthoringBundle
AiEvaluationDefinition
AIScoringModelDefinition
AIUsecaseDefinition
AnalyticsDashboard
AnalyticSnapshot
AnalyticsVisualization
AnalyticsWorkspace
AnimationRule
AppFrameworkTemplateBundle
ApexClass
ApexComponent
ApexEmailNotifications
ApexPage
ApexTestSuite
ApexTrigger
AppMenu
AppointmentAssignmentPolicy
AppointmentSchedulingPolicy
ApprovalProcess
AssignmentRules
AssessmentQuestion
AssessmentQuestionSet
Audience
AuraDefinitionBundle
AuthProvider
AutoResponseRules
BatchCalcJobDefinition
BatchProcessJobDefinition
BillingSettings
BlacklistedConsumer
Bot
BotBlock
BotTemplate
BotVersion
BrandingSet
BriefcaseDefinition
BusinessProcessGroup
CallCenter
CallCenterRoutingMap
CallCoachingMediaProvider
CampaignInfluenceModel
CaseSubjectParticle
CareBenefitVerifySettings
CareLimitType
CareSystemFieldMapping
CareProviderSearchConfig
CareRequestConfiguration
CatalogedApi
CatalogedApiArtifactVersionInfo
CatalogedApiVersion
Certificate
ChatterExtension
ChoiceList
ClaimFinancialSettings
ClauseCatgConfiguration
CleanDataService
CMSConnectSource
Community (Zone)
CommerceSettings
CommunityTemplateDefinition
CommunityThemeDefinition
ConnectedApp
ContentAsset
ContentTypeBundle
ContextDefinition
ConversationMessageDefinition
ConversationMessageDefinitionTranslation
ConversationVendorInfo
ConvIntelligenceSignalRule
CorsWhitelistOrigin
CspTrustedSite
CustomApplication
CustomApplicationComponent
CustomFeedFilter
CustomFieldDisplay
CustomHelpMenuSection
CustomIndex
CustomLabels
CustomNotificationType
CustomObjectTranslation
CustomPageWebLink
CustomPermission
CustomSite
CustomTab
CustomValue
Dashboard
DataCategoryGroup
DataObjectSearchIndexConf
DataWeaveResource
DecisionTable
DecisionTableDatasetLink
DecisionMatrixDefinition
DelegateGroup
DgtAssetMgmtProvider
DgtAssetMgmtPrvdLghtCpnt
DigitalExperienceConfig
DisclosureDefinition
DisclosureDefinitionVersion
DisclosureType
DiscoveryAIModel
DiscoveryGoal
DiscoveryStory
Document
DocumentCategory
DocumentCategoryDocumentType
DocumentChecklistSettings
DocumentType
DuplicateRule
EclairGeoData
EmailServicesFunction
EmailTemplate
EmbeddedServiceBranding
EmbeddedServiceConfig
EmbeddedServiceFieldService
EmbeddedServiceFlowConfig
EmbeddedServiceLiveAgent
EmbeddedServiceMenuSettings
EnablementMeasureDefinition
EnablementProgramDefinition
EnblProgramTaskSubCategory
EntitlementProcess
EntitlementTemplate
EscalationRules
EventDelivery
EventRelayConfig
EventSubscription
ExperienceBundle
ExperiencePropertyTypeBundle (Beta)
ExplainabilityMsgTemplate
ExpressionSetDefinition
ExpressionSetMessageToken
ExpressionSetObjectAlias
ExternalAuthIdentityProvider
ExternalClientApplication
ExternalCredential
ExternalAIModel
ExternalServiceRegistration
ExtlClntAppCanvasSettings
ExtlClntAppConfigurablePolicies
ExtlClntAppGlobalOauthSettings
ExtlClntAppMobileConfigurablePolicies
ExtlClntAppMobileSettings
ExtlClntAppNotificationSettings
ExtlClntAppOauthConfigurablePolicies
ExtlClntAppOauthSettings
ExtlClntAppPushConfigurablePolicies
ExtlClntAppPushSettings
ExtlClntAppSamlConfigurablePolicies
FeatureParameterBoolean
FeatureParameterDate
FeatureParameterInteger
FieldMappingConfig
FieldRestrictionRule
FlexiPage
Flow
FlowCategory
FlowDefinition
FlowTest
FlowValueMap
ForecastingFilter
ForecastingFilterCondition
ForecastingSourceDefinition
ForecastingType
ForecastingTypeSource
FuelType
FuelTypeSustnUom
FunctionReference
FundraisingConfig
GatewayProviderPaymentMethodType
GenAiFunction
GenAiPlanner
GenAiPlannerBundle
GenAiPlugin
GenAiPluginInstructionDef
GenAiPromptTemplate
GenAiPromptTemplateActv
GiftEntryGridTemplate
GlobalPicklist
GlobalPicklistValue
GlobalValueSet
GlobalValueSetTranslation
GoogleAppsSettings
Group
HomePageComponent
HomePageLayout
IdentityVerificationProcDef
IdentityVerificationProcDtl
IdentityVerificationProcFld
InboundCertificate
InboundNetworkConnection
IndustriesPricingSettings
IndustriesRatingSettings
IndustriesUnifiedInventorySettings
InstalledPackage
IntegArtifactDef
IntegrationProviderDef
IPAddressRange
InvocableActionExtension
KeywordList
Layout
LearningItemType
Letterhead
LightningBolt
LightningComponentBundle
LightningExperienceTheme
LightningMessageChannel
LightningOnboardingConfig
LightningTypeBundle
LiveChatAgentConfig
LiveChatButton
LiveChatDeployment
LiveChatSensitiveDataRule
LoyaltyProgramSetup
ManagedContentType
ManagedEventSubscription (Beta)
ManagedTopics
MarketingAppExtension
MatchingRule
MessagingChannel
Metadata
MetadataWithContent
MfgProgramTemplate
MilestoneType
MlDomain
MLDataDefinition
MLPredictionDefinition
MobileApplicationDetail
MobileSecurityAssignment
MobileSecurityPolicy
MobSecurityCertPinConfig
ModerationRule
MutingPermissionSet
MyDomainDiscoverableLogin
NamedCredential
NavigationMenu
Network
NetworkBranding
NotificationTypeConfig
OauthCustomScope
OauthTokenExchangeHandler
OcrSampleDocument
OcrTemplate
OmniSupervisorConfig
OutboundNetworkConnection
OnboardingDataObjectGroup
Package
ParticipantRole
PathAssistant
PaymentGatewayProvider
PermissionSet
PermissionSetGroup
PermissionSetLicenseDefinition (Developer Preview)
PersonAccountOwnerPowerUser
PipelineInspMetricConfig
PlatformCachePartition
PlatformEventChannel
PlatformEventChannelMember
PlatformEventSubscriberConfig
Portal
PortalDelegablePermissionSet
PostTemplate
ProductAttributeSet
PresenceDeclineReason
PresenceUserConfig
PricingActionParameters
PricingRecipe
Profile
ProfileActionOverride
ProfilePasswordPolicy
ProfileSessionSetting
Prompt
PublicKeyCertificate
PublicKeyCertificateSet
Queue
QueueRoutingConfig
QuickAction
RedirectWhitelistUrl
RecommendationStrategy
RecordActionDeployment
RecordAggregationDefinition
RecordAlertCategory
RegisteredExternalService
ReferencedDashboard
RelatedRecordAssocCriteria
RelationshipGraphDefinition
RemoteSiteSetting
Report
ReportType
RestrictionRule
RetrievalSummaryDefinition
Role
RoleOrTerritory
RpaRobotPoolMetadata
SalesWorkQueueSettings
SamlSsoConfig
SchedulingObjective
SchedulingRule
Scontrol
SearchCustomization
SearchOrgWideObjectConfig
ServiceAISetupDefinition
ServiceAISetupField
ServiceChannel
ServicePresenceStatus
ServiceProcess
SharedTo
SharingBaseRule
SharingSet
SiteDotCom
Skill
StandardValueSet
StandardValueSetTranslation
StaticResource
StageAssignment
StageDefinition
SustainabilityUom
SustnUomConversion
SvcCatalogCategory
SvcCatalogFulfillmentFlow
SvcCatalogItemDef
SynonymDictionary
Territory
Territory2
Territory2Model
Territory2Rule
Territory2Type
TimelineObjectDefinition
TimeSheetTemplate
TopicsForObjects
TransactionSecurityPolicy
Translations
UiFormatSpecificationSet
UIObjectRelationConfig
UiPreviewMessageTabDef
UserAccessPolicy
UserAuthCertificate
UserCriteria
UserProfileSearchScope
UserProvisioningConfig
VirtualVisitConfig
WaveAnalyticAssetCollection
WaveApplication
WaveComponent
WaveDataflow
WaveDashboard
WaveDataset
WaveLens
WaveRecipe
WaveTemplateBundle
WaveXmd
WebStoreBundle
WebStoreTemplate
Workflow
WorkSkillRouting
Metadata Types
Metadata API enables you to access some entities and feature settings that you can
customize in the user interface.
- Metadata type names are case-sensitive. Specifying a type name with an invalid case results in a deployment error.
- Metadata types don’t always correspond directly to their related data types. In some cases, the information is accessible but not organized as expected. For example, dependent picklists are exposed as a type of picklist, not a separate metadata type.
- The wildcard character doesn’t apply to metadata types for feature settings, like AccountSettings. The wildcard applies only when retrieving all settings and not an individual setting. See Settings.
Note
-
Metadata Coverage Report
Launch the Metadata Coverage report to determine supported metadata components. The Metadata Coverage report is the ultimate source of truth for metadata coverage across several channels. These channels include Metadata API, scratch org source tracking, unlocked packages, second-generation managed packages, classic managed packages, and more. -
Unsupported Metadata Types
Some Salesforce features have metadata types that aren’t available in Metadata API. These metadata types can’t be retrieved or deployed with Metadata API. To make changes to these types, you must do it manually in each of your organizations. -
Special Behavior in Metadata API Deployments
Important considerations for specific types and contents of a deployment. -
Metadata Type Limits
Certain metadata types have deploy and retrieve limits. Limits apply to each individual deploy or retrieve transaction, and there are daily limits for specific metadata types. -
Data 360 Metadata Types
Check out the metadata types that are used for development in Data 360. -
AccountPlanObjMeasCalcDef
Represents the metadata associated with an account plan objective measure calculation definition. An account plan objective measure calculation definition contains a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure. -
AccountRelationshipShareRule
The rule that determines which object records are shared, how they’re shared, the account relationship type that shares the records, and the level of access granted to the records. -
AccountingFieldMapping
Represents the accounting field mappings to organize your data and bring it to ledger entry records. -
AccountingModelConfig
Represents the mapping of the financial data model to a logical data model and configuration for the generation of Transaction Journal records. -
ActionLinkGroupTemplate
Represents the action link group template. Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. Every action link belongs to an action link group and action links within the group are mutually exclusive. -
ActionPlanTemplate
Represents the instance of an action plan template. -
ActionableListDefinition
Represents the data source definition details associated with an actionable list. -
AdvAccountForecastSet
Represents the forecast sets that define the forecast configurations for each business unit or different groups of accounts. With separate forecast sets at account or business unit level, you can focus on account-specific data and manage configuration updates for one business unit without impacting any other business unit’s data. -
AffinityScoreDefinition
Represents the affinity information used in calculations to analyze and categorize contacts for marketing purposes. -
AIApplication
Represents an instance of an AI application. For example, Einstein Prediction Builder. -
AIApplicationConfig
Additional prediction information related to an AI application. This type extends the Metadata metadata type and inherits its fullName field. -
AiAuthoringBundle
Represents an AI authoring bundle, which is a container for AI-related authoring content. For example, an AI authoring bundle for an Agentforce agent contains an Agent Script file and the associated metadata content. -
AiEvaluationDefinition
Represents an agent evaluation, including subject metadata and a set of test cases. -
AIScoringModelDefinition
Represents information about a machine learning model that’s used by the Scoring Framework for Industries Cloud Einstein. The machine learning model is used for scoring, including its configuration. -
AIUsecaseDefinition
Represents a collection of fields in your Salesforce org used to define a machine learning use case and get real-time predictions. -
AnalyticsDashboard
Represents a Tableau Next dashboard. -
AnalyticSnapshot
Represents a reporting snapshot. A reporting snapshot lets you report on historical data. Authorized users can save tabular or summary report results to fields on a custom object, then map those fields to corresponding fields on a target object. They can then schedule when to run the report to load the custom object's fields with the report's data. Reporting snapshots enable you to work with report data similarly to how you work with other records in Salesforce. -
AnalyticsVisualization
Represents a Tableau Next visualization. -
AnalyticsWorkspace
Represents a Tableau Next workspace. -
AnimationRule
Represents criteria for determining when an animation is displayed to Path users.This type extends the Metadata metadata type and inherits its fullName field. -
AppFrameworkTemplateBundle
Represents the app framework template bundle. Use these templates for Data 360 and Tableau Next assets. -
ArticleType
Represents the metadata associated with an article type. -
ApexClass
Represents an Apex class. An Apex class is a template or blueprint from which Apex objects are created. Classes consist of other classes, user-defined methods, variables, exception types, and static initialization code. -
ApexComponent
Represents a Visualforce component. -
ApexEmailNotifications
The ApexEmailNotifications type allows you to define users and email addresses that receive email for unhandled Apex errors. Flow errors can also use this metadata type. -
ApexPage
Represents a Visualforce page. -
ApexTestSuite
Represents a suite of Apex test classes to include in a test run. -
ApexTrigger
Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur, such as before object records are inserted into the database, or after records have been deleted. -
AppMenu
Represents the app menu or the Salesforce mobile navigation menu. Reserved for future use. -
AppointmentAssignmentPolicy
Represents the information about a resource assignment rule. This type extends the Metadata metadata type and inherits its fullName field. -
AppointmentSchedulingPolicy
Represents a set of rules for scheduling appointments using Lightning Scheduler. This type extends the Metadata metadata type and inherits its fullName field. -
ApprovalProcess
Represents the metadata associated with an approval process. An approval process automates how records are approved in Salesforce. An approval process specifies each step of approval, including who to request approval from and what to do at each point of the process. -
AssignmentRules
Represents assignment rules that allow you to automatically route cases to the appropriate users or queues. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object. -
AssessmentQuestion
Represents the container object that stores the questions required for an assessment. -
AssessmentQuestionSet
Represents the container object for Assessment Questions. -
Audience
Represents the audience in an Experience Builder site. An audience consists of different types of criteria, where the audience can be assigned and used for targeting in a site. This type extends the Metadata metadata type and inherits its fullName field. -
AuraDefinitionBundle
Represents an Aura definition bundle. A bundle contains an Aura definition, such as an Aura component, and its related resources, such as a JavaScript controller. The definition can be a component, application, event, interface, or a tokens collection. -
AuthProvider
Represents an authentication provider (auth provider). An auth provider lets users log in to Salesforce from an external service provider such as Facebook, Google, or GitHub. This type extends the Metadata metadata type and inherits its fullName field. -
AutoResponseRules
Represents an auto-response rule that sets conditions for sending automatic email responses to lead or case submissions based on the attributes of the submitted record. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object. -
BatchCalcJobDefinition
Represents a Data Processing Engine definition. -
BatchProcessJobDefinition
Represents the details of a Batch Management job definition. -
BillingSettings
Represents the settings for Salesforce Billing. -
BlacklistedConsumer
Represents a connected app that is inaccessible to your Salesforce org’s users. This type extends the Metadata metadata type and inherits its fullName field. -
Bot
Represents a definition of an Einstein Bot configuration that can have one or more versions. Only one version can be active. -
BotBlock
Represents the configuration details for a specific Einstein Bot block, including dialogs and variables. -
BotTemplate
Represents the configuration details for a specific Einstein Bot template, including dialogs and variables. -
BotVersion
Represents the configuration details for a specific Einstein Bot version, including dialogs and variables. -
BrandingSet
Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme. -
BriefcaseDefinition
Represents a briefcase definition. A briefcase makes selected records available for specific users and groups to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This type extends the Metadata metadata type and inherits its fullName field. -
BusinessProcessGroup
Represents the surveys used to track customers’ experiences across different stages in their lifecycle. This type extends the Metadata metadata type and inherits its fullName field. -
CallCenter
Represents the Call Center definition used to integrate Salesforce with a third-party computer-telephony integration (CTI) system, a partner telephony system, or partner Contact Center as a Service (CCaaS) system. -
CallCenterRoutingMap
Represents the mapping between a user or queue in a Salesforce org to a user or queue in an external system’s call center. -
CallCoachingMediaProvider
Represents the CallCoachingMediaProvider configuration. Use CallCoachingMediaProvider to configure which providers of voice recordings that Einstein Conversation Insights can use. For example, Sales Dialer can provide voice recordings. Einstein Conversation Insights then stores and analyzes call recordings to surface insights and trends in customer conversations.This type extends the Metadata metadata type and inherits its fullName field. -
CampaignInfluenceModel
Represents a campaign influence model used by Customizable Campaign Influence. You can’t configure Customizable Campaign Influence via the Metadata API, but you can add a campaign influence model. -
CaseSubjectParticle
Represents the Social Business Rules custom format for the Case Subject field on cases created from inbound social posts. -
CareBenefitVerifySettings
Represents the configuration settings for benefit verification requests. -
CareLimitType
Defines the characteristics of limits on benefit provision. -
CareSystemFieldMapping
Represents a mapping from source system fields to Salesforce objects and fields. This type extends the Metadata metadata type and inherits its fullName field. -
CareProviderSearchConfig
Represents the information about the fields that appear in care provider search results. This type extends the Metadata metadata type and inherits its fullName field. -
CareRequestConfiguration
Represents the details for a record type such as service request, drug request, or admission request. One or more record types can be associated with a care request. -
CatalogedApi
Represents an API brought into API Catalog for Salesforce from an external source. -
CatalogedApiArtifactVersionInfo
Represents API version information in API Catalog that’s referenced by other entities. -
CatalogedApiVersion
Represents a version of an API that is consumable in Salesforce using API Catalog. -
Certificate
Represents a certificate used for digital signatures that verify that requests are coming from your org. Certificates are used for either authenticated single sign-on with an external website, or when using your org as an identity provider. This type extends the Metadata With Content metadata type and inherits its content and fullName fields. -
ChatterExtension
Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher. -
ChoiceList
Represents the Choicelist dropdown field that’s used for pre-chat. -
ClaimFinancialSettings
Represents the configuration settings for Insurance Claim Financial Services. -
ClauseCatgConfiguration
Represents the configuration about the clause category that can be used to categorize your disclosure and compliance reports from standardized disclosure templates in a response document. -
CleanDataService
Represents a data service that adds and updates data in standard objects. -
CMSConnectSource
Represents the connection information for external content management systems that feed content to Experience Builder sites. This type extends the Metadata metadata type and inherits its fullName field. -
Community (Zone)
Represents a zone that contains Ideas or Chatter Answers objects. Zones are shared by the Ideas, Answers, and Chatter Answers features, allowing you to view and create zones from those locations.This type extends the Metadata metadata type and inherits its fullName field. -
CommerceSettings
Represents settings for various Commerce features. -
CommunityTemplateDefinition
Represents the definition of an Experience Builder site template. This type extends the Metadata metadata type and inherits its fullName field. -
CommunityThemeDefinition
Represents the definition of a theme for an Experience Builder site. This type extends the Metadata metadata type and inherits its fullName field. -
ConnectedApp
Represents a connected app configuration. A connected app enables an external application to integrate with Salesforce using APIs and standard protocols, such as SAML, OAuth, and OpenID Connect. Connected apps use these protocols to authenticate, authorize, and provide single sign-on (SSO) for external apps. The external apps that are integrated with Salesforce can run on the customer success platform, other platforms, devices, or SaaS subscriptions. -
ContentAsset
Represents the metadata for creating an asset file. Asset files enable a Salesforce file to be used for org setup and configuration purposes. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields. -
ContentTypeBundle
Represents the definition of enhanced custom content types for use with enhanced CMS workspaces. When you create an enhanced custom content type, deploy this bundle to your org. Enhanced custom content types are displayed as forms with defined fields. When deployed, enhanced custom content types are available for use with enhanced LWR site channels. To use enhanced custom content types with Aura and non-enhanced LWR site channels, use enhanced CMS workspaces resources. -
ContextDefinition
Represents the details of a context definition that describe the relationship between the node structures within a context. -
ConversationMessageDefinition
Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session. -
ConversationMessageDefinitionTranslation
Represents translated labels and constant values for conversation message definitions in Enhanced Messaging and Messaging for In-App and Web. -
ConversationVendorInfo
Represents the connection between the partner vendor system and the Service Cloud feature. For example, for Service Cloud Voice, this type contains information about the partner telephony system or Contact Center as a Service (CCaaS) system. For Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS, this type contains information about the partner messaging system or CCaaS system. -
ConvIntelligenceSignalRule
Represents the conversation intelligence signal rule. The rule triggers actions based on real-time intelligence signals from your telephony system or keywords mentioned by support reps or customers. The rule contains a set of conditions (subrules) and the filter logic used to evaluate those conditions to determine whether to trigger actions. -
CorsWhitelistOrigin
Represents an origin in the CORS allowlist. -
CspTrustedSite
Represents a trusted URL. For each CspTrustedSite component, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite components included only CSP directives and were referred to as CSP Trusted Sites. -
CustomApplication
CustomApplication represents a custom or standard application. In API version 29.0 and earlier, CustomApplication represents only a custom application. An application is a list of tab references, with a description and a logo. This type extends the Metadata metadata type and inherits its fullName field. -
CustomApplicationComponent
Represents a custom console component (Visualforce page) assigned to a CustomApplication that is marked as a Salesforce console. Custom console components extend the capabilities of Salesforce console apps. See Customize a Console with Custom Components in Salesforce Classic in Salesforce Help. -
CustomFeedFilter
Represents a custom feed filter that limits the feed view to feeds from the Cases object. The custom feed filter shows only feed items that satisfy the criteria specified in the CustomFeedFilter definition. This type extends the Metadata metadata type and inherits its fullName field. -
CustomFieldDisplay
Represents the view type assigned to product attribute custom fields. This type extends the Metadata metadata type and inherits its fullName field. -
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. This type extends the Metadata metadata type and inherits its fullName field. -
CustomIndex
Represents an index used to increase the speed of queries.This type extends the Metadata metadata type and inherits its fullName field. -
CustomLabels
The CustomLabels metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies. -
Custom Metadata Types (CustomObject)
Represents the metadata associated with a custom metadata type. -
CustomNotificationType
Represents the metadata associated with a custom notification type. -
CustomObject
Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org. -
CustomObjectTranslation
This metadata type allows you to translate custom objects for a variety of languages. -
CustomPageWebLink
Represents a custom link defined in a home page component. -
CustomPermission
Represents a permission that grants access to a custom feature. This type extends the Metadata metadata type and inherits its fullName field. -
CustomSite
Represents a Salesforce site. Create public websites and applications that are directly integrated with your Salesforce organization, but don't require users to log in with a username and password. -
CustomTab
Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce. When you add a custom tab to an app in Salesforce Classic, it appears as a tab. When you add a custom tab to an app in Lightning Experience, it appears as an item in the app’s navigation bar and in the App Launcher. When a tab displays a custom object, the tab name is the same as the custom object name. For page, s-control, or URL tabs, the name is arbitrary. -
CustomValue
Represents the definition of a value used in a global value set or local custom picklist. Custom picklist fields can be local and unique, or can inherit their values from a global picklist (called a global value set in API version 38.0). This type extends the Metadata metadata type and inherits its fullName field. -
Dashboard
Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance. -
DataCategoryGroup
Represents a data category group. -
DataObjectSearchIndexConf
Represents the source Data 360 data model object (DMO) for Search Answers and holds the search index that Search Answers uses when searching DMO records. -
DataWeaveResource
Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. DataWeave scripts can be directly invoked from Apex. -
DecisionTable
Represents the information about a decision table. -
DecisionTableDatasetLink
Represents the information about a dataset link associated with a decision table. In a dataset link, select an object for whose records, the decision table must provide an outcome. This type extends the Metadata metadata type and inherits its fullName field. -
DecisionMatrixDefinition
Represents a definition of a decision matrix. -
DelegateGroup
Represents a group of users who have the same administrative privileges. These groups are different from public groups used for sharing. -
DgtAssetMgmtProvider
Represents external content providers, such as digital asset management (DAM) systems, that integrate with Salesforce CMS. When combined with the DgtAssetMgmtPrvdLghtCpnt type, this metadata type enables organizations to configure external content systems as content providers within the Salesforce platform. -
DgtAssetMgmtPrvdLghtCpnt
Represents the Lightning web component configurations for external content providers, such as digital asset management (DAM) systems. This metadata type enables the integration of external content systems with Salesforce CMS using custom Lightning web components. -
DigitalExperienceBundle
Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items. -
DigitalExperienceConfig
Represents details for your organization’s workspaces, such as the site label, site URL path prefix, and workspace type. -
DisclosureDefinition
Represents information that defines a disclosure type, such as details of the publisher or vendor who created or implemented the report. -
DisclosureDefinitionVersion
Represents the version information about the disclosure definition. -
DisclosureType
Represents the types of disclosures that are done by an individual or an organization and the associated metadata. -
DiscoveryAIModel
Represents the metadata associated with a model used in Einstein Discovery. -
DiscoveryGoal
Represents the metadata associated with an Einstein Discovery prediction definition. -
DiscoveryStory
Represents the metadata associated with a story used in Einstein Discovery. -
Document
Represents a Document. All documents must be in a document folder, such as sampleFolder/TestDocument. -
DocumentCategory
Represents a document category. -
DocumentCategoryDocumentType
Represents the junction between a DocumentCategory and a DocumentType. Puts a DocumentType in a DocumentCategory. -
DocumentChecklistSettings
Represents an org’s DocumentChecklistItem settings. -
DocumentType
Represents a document type. -
DuplicateRule
Represents a rule that specifies how duplicate records in an object are detected. This type extends the Metadata metadata type and inherits its fullName field. -
EclairGeoData
Represents an Analytics custom map chart. Custom maps are user-defined maps that are uploaded to Analytics and are used just as standard maps are. Custom maps are accessed in Analytics from the list of maps available with the map chart type. -
EmailServicesFunction
Represents an email service. This type extends the Metadata metadata type and inherits its fullName field. -
EmailTemplate
Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only. -
EmbeddedServiceBranding
Represents the branding for each Embedded Service deployment. This type extends the Metadata metadata type and inherits its fullName field. -
EmbeddedServiceConfig
Represents a setup node for creating an Embedded Service for Web deployment. This type extends the Metadata metadata type and inherits its fullName field. -
EmbeddedServiceFieldService
Represents a setup node for creating an embedded Appointment Management deployment. This type extends the Metadata metadata type and inherits its fullName field. -
EmbeddedServiceFlowConfig
Represents a setup node for creating an embedded flow. This type extends the Metadata metadata type and inherits its fullName field. -
EmbeddedServiceLiveAgent
Represents a setup node for creating an embedded chat deployment. This type extends the Metadata metadata type and inherits its fullName field. -
EmbeddedServiceMenuSettings
Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This type extends the Metadata metadata type and inherits its fullName field. -
EnablementMeasureDefinition
Represents an Enablement measure, which specifies the job-related activity that a user performs to complete a milestone or outcome in an Enablement program. A measure identifies a source object and optional related objects, with optional field filters and filter logic, for tracking the activity. To avoid deployment errors, deploy measures before you deploy programs. -
EnablementProgramDefinition
Represents an Enablement program, which includes exercises and measurable milestones to help users such as sales reps achieve specific outcomes related to your company’s revenue goals. -
EnblProgramTaskSubCategory
Represents a custom exercise type that an Enablement admin adds to an Enablement program in Program Builder. A custom exercise type also requires a corresponding EnblProgramTaskDefinition record for Program Builder and corresponding LearningItem and LearningItemType records for when users take the exercise in the Guidance Center. -
EntitlementProcess
Represents the settings for an entitlement process. -
EntitlementTemplate
Represents an entitlement template. Entitlement templates are predefined terms of customer support that you can quickly add to products. For example, you can create entitlement templates for Web or phone support so that users can easily add entitlements to products offered to customers. -
EscalationRules
Represents case escalation rules to escalate cases automatically if they aren’t resolved within a certain time. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object. -
EventDelivery
Represents how an event instance maps to a target payload. Removed in API version 46.0. This type extends the Metadata metadata type and inherits its fullName field. -
EventRelayConfig
Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge. -
EventSubscription
Represents a subscription to an event type. Removed in API version 46.0. This type extends the Metadata metadata type and inherits its fullName field. -
ExperienceBundle
Represents a text-based code structure of the settings and site components, such as pages, branding sets, and themes that make up an Experience Builder site. Developers can quickly update and deploy Experience Builder sites programmatically using their preferred development tools. This type extends the Metadata metadata type and inherits its fullName field. -
ExperiencePropertyTypeBundle (Beta)
Represents a property type. Replaced in Spring ’26 by the updated LightningPropertyType. When you create a custom property type for a Lightning web component, use LightningPropertyType instead, and deploy that bundle to your org. -
ExplainabilityMsgTemplate
Represents information about the template that contains the decision explanation message for a specified expression set step type. -
ExpressionSetDefinition
Represents an expression set definition. -
ExpressionSetMessageToken
Represents an interface to retrieve, deploy, create, update, or delete information on Expression Set Message Token. -
ExpressionSetObjectAlias
Represents information about the alias of the source object that’s used in an expression set. -
ExternalAuthIdentityProvider
Represents an external authentication (auth) identity provider. An external auth identity provider links to an external credential and obtains OAuth tokens for outbound callouts to external systems. -
ExternalClientApplication
Represents the header file for an external client application configuration. -
ExternalCredential
Represents the details of how Salesforce authenticates to the external system. -
ExternalAIModel
Represents the state of a given model for an Einstein for Service feature, such as Einstein Reply Recommendations. -
ExternalServiceRegistration
Represents the external service configuration for an org. -
ExtlClntAppCanvasSettings
Represents an external client app’s canvas app settings. -
ExtlClntAppConfigurablePolicies
Represents the policies for an external client app to disable or enable plugins. -
ExtlClntAppGlobalOauthSettings
Represents the global settings for the OAuth plugin in an external client app. These settings include private and sensitive OAuth consumer information that can’t be packaged and must not be added to source control. -
ExtlClntAppMobileConfigurablePolicies
Represents an external client app’s mobile policies configuration. -
ExtlClntAppMobileSettings
Represents an external client app’s mobile app settings, such as screen lock on a mobile device. -
ExtlClntAppNotificationSettings
Represents an external client app’s notification subscriptions for mobile. -
ExtlClntAppOauthConfigurablePolicies
Represents the policies configured by the admin for an OAuth-enabled external client app. -
ExtlClntAppOauthSettings
Represents the settings configuration for the external client app’s OAuth plugin. -
ExtlClntAppPushConfigurablePolicies
Represents an external client app’s push notification policies configuration. -
ExtlClntAppPushSettings
Represents an external client app’s push notification settings. -
ExtlClntAppSamlConfigurablePolicies
Represents SAML configuration policies for an external client app. Use this type to configure Salesforce as an identity provider for SAML single sign-on (SSO). In this type of SSO configuration, users log in to a third-party service provider, such as Google, using their Salesforce credentials. -
FeatureParameterBoolean
Represents a boolean feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field. -
FeatureParameterDate
Represents a date feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field. -
FeatureParameterInteger
Represents an integer feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package. This type extends the Metadata metadata type and inherits its fullName field. -
FieldMappingConfig
Represents the configuration for fields mapped between a source object and one or more destination objects and fields. This object is available in API version 63.0 and later. -
FieldRestrictionRule
Represents a field visibility rule that controls whether a field is visible to a user, based on the field’s inclusion in a field set. If Enhanced Personal Information Management setting was enabled before Spring ’22, field visibility is based on the field’s compliance categorization. This type extends the Metadata metadata type and inherits its fullName field. -
FlexiPage
Represents the metadata associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components. -
Flow
Represents the metadata associated with a flow that encompasses the flow's structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions. -
FlowCategory
Represents a list of flows that are grouped by category. Flows aren’t added directly to a Lightning Bolt Solution. Instead, add the category the flows are in to the Lightning Bolt Solution. This type extends the Metadata metadata type and inherits its fullName field. -
FlowDefinition
Represents the flow definition’s description and active flow version number. -
FlowTest
Represents the metadata associated with a flow test. Before you activate a record-triggered flow, you can test it to verify its expected results and identify flow run-time failures. -
FlowValueMap
Reserved for future use. -
Folder
Represents a folder. This type extends the Metadata metadata type and inherits its fullName field. -
ForecastingFilter
Represents the custom filter for including or excluding data from opportunity forecasts. -
ForecastingFilterCondition
Represents the custom filter condition logic for including or excluding data from opportunity forecasts. -
ForecastingSourceDefinition
Represents the object, measure, date type, and hierarchy that a forecast uses to project sales. -
ForecastingType
Represents a forecast type. -
ForecastingTypeSource
Represents the mapping of a forecasting source definition to a forecast type. -
FuelType
Represents a custom fuel type in an org. -
FuelTypeSustnUom
Represents a mapping between the custom fuel types and their corresponding unit of measure (UOM) values defined by a customer in an org. -
FunctionReference
Represents information about a deployed Salesforce Function that can be invoked from the org. This type extends the Metadata metadata type and inherits its fullName field. -
FundraisingConfig
Represents a collection of settings to configure the fundraising product. -
GatewayProviderPaymentMethodType
Represents an entity that allows integrators and payment providers to choose an active payment to receive an order's payment data rather than allowing the Salesforce Order Management platform to select a default payment method. This object is available in API version 51 and later. -
GenAiFunction
Represents an agent action that can be added to an AI agent. -
GenAiPlanner
Represents a planner for an agent. It’s a container for all the topics and actions used to interact with a large language model (LLM). -
GenAiPlannerBundle
Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM). -
GenAiPlugin
Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents. -
GenAiPluginInstructionDef
Represents a topic instruction. -
GenAiPromptTemplate
Represents the definition of a prompt template, including its related objects and fields. -
GenAiPromptTemplateActv
Represents the activation status of a Salesforce-provided prompt template. -
GiftEntryGridTemplate
Represents templates that customize the gift entry grid in Fundraising. -
GlobalPicklist
Represents a global picklist, or the set of shared picklist values that custom picklist fields can use. In contrast, the custom picklist fields that are based on a global picklist are of type CustomValue. This type extends the Metadata metadata type and inherits its fullName field. -
GlobalPicklistValue
Represents the definition of a value used in a global picklist. Custom picklist fields can inherit the picklist value set from a global picklist. -
GlobalValueSet
Represents the metadata for a global picklist value set, which is the set of shared values that custom picklist fields can use. A global value set isn’t a field itself. In contrast, the custom picklist fields that are based on a global picklist are of type ValueSet. This type extends the Metadata metadata type and inherits its fullName field. -
GlobalValueSetTranslation
Contains details for a global value set translation. Global value sets are lists of values that can be shared by multiple custom picklist fields, optionally across objects. This type extends the Metadata metadata type and inherits its fullName field. -
GoogleAppsSettings
Represents the settings for Google Apps in Salesforce. -
Group
Represents a set of public groups, which can have users, roles, and other groups. -
HomePageComponent
Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions. -
HomePageLayout
Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile. -
IdentityVerificationProcDef
Represents the definition of the identity verification process. -
IdentityVerificationProcDtl
Represents the search functionality configuration and the minimum number of optional verifiers for identity verification. This type extends the Metadata metadata type and inherits its fullName field. -
IdentityVerificationProcFld
Represents the search and verification fields used in identity verification. This type extends the Metadata metadata type and inherits its fullName field. -
InboundCertificate
Represents a mutual authentication certificate that is imported to your Salesforce org. -
InboundNetworkConnection
Represents a private connection between a third-party data service and a Salesforce org. The connection is inbound because the callouts are coming into Salesforce.This type extends the Metadata metadata type and inherits its fullName field. -
IndustriesPricingSettings
Represents the settings for Salesforce Pricing. -
IndustriesRatingSettings
Represents the settings for Rate Management. -
IndustriesUnifiedInventorySettings
Represents the settings for Industries Unified Inventory. -
InstalledPackage
Represents a first-generation managed package to be installed or uninstalled. Deploying a newer version of a currently installed package upgrades the package. You can install up to 20 first-generation managed packages in a single deployment. To install an unlocked or second-generation managed package, use the sf package install Salesforce CLI command. -
IntegArtifactDef
For internal use only. -
IntegrationProviderDef
Represents an integration definition associated with a service process. Stores data for the Industries: Send Apex Async Request and Industries: Send External Async Request invocable actions. -
IPAddressRange
Represents a range of IP addresses to include in or exclude from the specified feature. -
InvocableActionExtension
Represents the configuration that defines how an action's inputs are presented in a user interface. -
KeywordList
Represents a list of keywords used in Experience Cloud site moderation. This keyword list is a type of moderation criteria that defines offensive language or inappropriate content that you don’t want in your site. -
Layout
Represents the metadata associated with a page layout. For more information, see Page Layouts in Salesforce Help. -
LearningItemType
Represents a custom exercise type that an Enablement user takes in an Enablement program in the Guidance Center. A custom exercise type also requires a corresponding LearningItem record for the Guidance Center and corresponding EnblProgramTaskDefinition and EnblProgramTaskSubCategory records for when admins create a program in Program Builder. -
Letterhead
Represents formatting options for the letterhead in an email template. A letterhead defines the logo, page color, and text settings for your HTML email templates. Use letterheads to ensure a consistent look and feel in your company’s emails. -
LightningBolt
Represents the definition of a Lightning Bolt Solution, which can include custom apps, flow categories, and Experience Builder templates. This type extends the Metadata metadata type and inherits its fullName field. -
LightningComponentBundle
Represents a Lightning web component bundle. A bundle contains Lightning web component resources. -
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. -
LightningMessageChannel
Represents the metadata associated with a Lightning Message Channel. A Lightning Message Channel represents a secure channel to communicate across UI technologies, such as Lightning Web Components, Aura Components, and Visualforce. -
LightningOnboardingConfig
Represents the feedback provided when users switch from Lightning Experience to Salesforce Classic. Admins can customize the question, how frequently the form appears, and where the feedback is stored in Chatter from the Adoption Assistance page in Lightning Experience Setup. This type extends the Metadata metadata type and inherits its fullName field. -
LightningTypeBundle
Represents a custom Lightning type. Use this type to override the default user interface to create a customized appearance based on your business requirements. Deploy this bundle to your organization to implement the overrides. -
LiveChatAgentConfig
Represents the configuration of an organization’s Chat deployment, such as how many chats can be assigned to an agent and whether chat sounds are enabled. -
LiveChatButton
Represents a Chat deployment’s settings for the button that customers click to chat with an agent and the chat window, such as the label that appears on the button and the pre-chat form that appears before a chat begins. This type extends the Metadata metadata type and inherits its fullName field. -
LiveChatDeployment
Represents the configuration settings for a specific Chat deployment, such as the branding image for the deployment and whether or not chat transcripts are automatically saved. -
LiveChatSensitiveDataRule
Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex). -
LoyaltyProgramSetup
Represents the configuration of a loyalty program process including its parameters and rules. Program processes determine how new transaction journals are processed. When new transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals. -
ManagedContentType
Represents the definition of custom content types for use with Salesforce CMS. Custom content types are displayed as forms with defined fields. -
ManagedEventSubscription (Beta)
Represents a managed event subscription in Pub/Sub API. Use a managed event subscription to track the events that a subscriber client consumed and resume a subscription where it left off. This type extends the metadata type and inherits its fullName field. -
ManagedTopics
Represents navigational and featured topics managed in an Experience Cloud site. -
MarketingAppExtension
Represents an integration with a third-party app or service that is used to work with prospects. -
MatchingRule
Represents a matching rule that is used to identify duplicate records. -
MessagingChannel
Represents the metadata associated with an Embedded Service Messaging channel. -
Metadata
The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type. -
MetadataWithContent
MetadataWithContent is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You can’t edit this object. -
MfgProgramTemplate
Represents a definition of a program to create a program-based business. A program-based business, also known as a Manufacturing Program, enables manufacturers to drive their business models with forecasting tools and manage the end-to-end sales process efficiently. -
MilestoneType
Represents the name and description of a milestone, which you can use in an entitlement process to track important steps in cases. -
MlDomain
Represents an Einstein Intent Set. -
MLDataDefinition
Represents a modeling data definition, which specifies the data used to create a model. Such data can include filters, fields to include, fields to exclude, and so on. This type extends the Metadata metadata type and inherits its fullName field. -
MLPredictionDefinition
Represents a prediction definition that specifies details about the prediction. This type extends the Metadata metadata type and inherits its fullName field. -
MobileApplicationDetail
Represents the packaging attributes for a mobile connected app. This type extends the Metadata metadata type and inherits its fullName field. -
MobileSecurityAssignment
Represents the assignment of mobile app security policies to a profile. The policies apply to the Salesforce mobile app with Enhanced Mobile App Security enabled. -
MobileSecurityPolicy
Represents a mobile app security policy on the Salesforce mobile app with Enhanced Mobile App Security enabled. For a full description of each policy, see Enable and Configure Mobile App Security Policies. -
MobSecurityCertPinConfig
Represents the authentication server certificate pin configuration on the Salesforce mobile app with Enhanced Mobile Security. -
ModerationRule
Represents a rule used in your Experience Cloud site to moderate member-generated content. Each rule specifies the member-generated content the rule applies to, the criteria to enforce the rule on, and the moderation action to take. Moderation rules help protect your site from spammers, bots, and offensive or inappropriate content. This type extends the Metadata metadata type and inherits its fullName field. -
MutingPermissionSet
Represents a set of disabled permissions and is used in conjunction with PermissionSetGroup. -
MyDomainDiscoverableLogin
Represents the configuration settings when the My Domain login page type is Discovery. Login Discovery provides an identity-first login experience, where the login page contains the identifier field only. Based on the identifier entered, a handler determines how to authenticate the user. This type extends the Metadata metadata type and inherits its fullName field. -
NamedCredential
Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. -
NavigationMenu
Represents the navigation menu in an Experience Builder site. A navigation menu consists of items that users can click to go to other parts of the site. This type replaces the NavigationLinkSet subtype on Network. NavigationMenu is available in API version 47.0 and later. This type extends the Metadata metadata type and inherits its fullName field. -
Network
Represents an Experience Cloud site. Salesforce Experience Cloud lets you create branded spaces for your employees, customers, and partners. You can customize and create experiences, whether they’re communities, sites, or portals, to meet your business needs, then transition seamlessly between them. If you want to create zones that contain Chatter Answers and Ideas, use the Community (Zone) component. -
NetworkBranding
Represents the branding and color scheme applied to the login pages of an Experience Cloud site. (Experience Cloud sites are represented by the Network component.) -
NotificationTypeConfig
Represents the metadata associated with org-level notification settings for standard and custom notification types. This type extends the Metadata metadata type and inherits its fullName field. -
OauthCustomScope
Represents a permission defining the protected data that a connected app can access from an external entity when Salesforce is the OAuth authorization provider. This type extends the Metadata metadata type and inherits its fullName field. -
OauthTokenExchangeHandler
Represents a token exchange handler. The token exchange handler also consists of an Apex class. During the OAuth 2.0 token exchange flow, the token exchange handler is used to validate tokens from an external identity provider and to map users to Salesforce. -
OcrSampleDocument
Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. This type extends the Metadata metadata type and inherits its fullName field. -
OcrTemplate
Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader. This type extends the Metadata metadata type and inherits its fullName field. -
OmniSupervisorConfig
Represents the Omni-Channel supervisor configuration for an assigned group of supervisors. -
OutboundNetworkConnection
Represents a private connection between a Salesforce org and a third-party data service. The connection is outbound because the callouts are going out of Salesforce. This type extends the Metadata metadata type and inherits its fullName field. -
OnboardingDataObjectGroup
Represents a configuration that groups fields from one or more objects for a specific business purpose. For example, the Customer Contact Information onboarding data object group includes Name, Email, Phone Number, and Address. -
Package
Specifies which metadata components to retrieve as part of a retrieve() call or defines a package of components. -
ParticipantRole
Represents details, such as the name and associated default access level, for a role that a participant can have in the context of a parent record. -
PathAssistant
Represents Path records.This type extends the Metadata metadata type and inherits its fullName field. -
PaymentGatewayProvider
Represents the metadata associated with a payment gateway provider. This type extends the Metadata metadata type and inherits its fullName field. -
PermissionSet
Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access. -
PermissionSetGroup
Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed. -
PermissionSetLicenseDefinition (Developer Preview)
Represents the definition of a custom permission set license, which entitles specified features in a package. -
PersonAccountOwnerPowerUser
Represents a user who can own more than 50,000 customer or partner portal accounts. Person account owner power users can own a large number of either customer or partner users. They can’t change their role, look up to a parent role, or reparent their role. Person account owner power user objects can't be created if deferred sharing is turned on for your org. This object is available in API version 57.0 and later. -
PipelineInspMetricConfig
Represents the settings of Pipeline Inspection forecast category metrics. -
PlatformCachePartition
Represents a partition in the Platform Cache. This type extends the Metadata metadata type and inherits its fullName field. -
PlatformEventChannel
Represents a channel that you can subscribe to in order to receive a stream of events. In API version 46.0 and earlier, it is the default standard channel for change data capture events. In API version 47.0 and later, it is a custom channel for change data capture events. -
PlatformEventChannelMember
Represents an entity selected for Change Data Capture notifications on a standard or custom channel, or a platform event selected on a custom channel. -
PlatformEventSubscriberConfig
Represents configuration settings for a platform event Apex trigger, including the batch size and the trigger’s running user. -
Portal
The Portal metadata type represents a partner portal. -
PortalDelegablePermissionSet
Represents the org-level permission sets that can be assigned to a particular profile for external users or shoppers in a store after enabling the Delegable Administration perm. -
PostTemplate
Represents the metadata associated with an approval post template for Approvals in Chatter. With approval post templates, you can customize the information included in approval request posts that appear in Chatter feeds. This type extends the Metadata metadata type and inherits its fullName field. -
ProductAttributeSet
Represents the ProductAttribute information being used as and attribute such as color_c, size_c . -
PresenceDeclineReason
Represents an Omni-Channel decline reason that agents can select when declining work requests. This type extends the Metadata metadata type and inherits its fullName field. -
PresenceUserConfig
Represents a configuration that determines a presence user’s settings. -
PricingActionParameters
Represents the pricing action that's associated with a context definition and pricing procedure. -
PricingRecipe
Represents the data models or sets of objects of a particular cloud that the pricing data store consumes during design time and run time. -
Profile
Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field. -
ProfileActionOverride
Represents an override of an ActionOverride by a user profile. You can use it to override an ActionOverride on a standard Home tab or object record page in Lightning Experience. When a user logs in with a profile, a matching ProfileActionOverride assignment takes precedence over existing overrides for the Home tab or record page specified in ActionOverride. In API versions 39.0 to 44.0, you can access ProfileActionOverride by accessing its encompassing CustomApplication or Profile metadata types. In API version 45.0 and later, you can access ProfileActionOverride only by accessing its encompassing CustomApplication. -
ProfilePasswordPolicy
Represents a profile’s password policies. Profile password policies override org-wide password policies for that profile’s users. Use ProfilePasswordPolicy to retrieve password policies for a given profile. This type extends the Metadata metadata type and inherits its fullName field. -
ProfileSessionSetting
Represents a profile’s session settings. Use ProfileSessionSetting to retrieve the session settings for a given profile. This type extends the Metadata metadata type and inherits its fullName field. -
Prompt
Represents the metadata related to in-app guidance, which includes prompts and walkthroughs. Help users discover your products and services, adopt your processes, or learn how to use a new feature. Write the content, select the target audience, and specify where and when the in-app guidance appears. -
PublicKeyCertificate
Represents the public key certificate. On this entity we store a public certificate or a JSON web key, which is used to validate the customer-provided JWT. -
PublicKeyCertificateSet
Represents a set of public certificate keys. On this entity we store a public certificates or JSON web keys. -
Queue
Represents a holding area for items before they are processed. -
QueueRoutingConfig
Represents the settings that determine how work items are routed to agents. -
QuickAction
Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields. -
RedirectWhitelistUrl
Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true. This type extends the Metadata metadata type and inherits its fullName field. -
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 configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. For example, you can have a deployment that specifies which types of actions to display, default actions for channels, and the actions that users can add at runtime. If the component shows Next Best Action recommendations, the deployment configures which strategies to use and how recommendations appear. This type extends the Metadata metadata type and inherits its fullName field. -
RecordAggregationDefinition
Represents a data aggregation from one object to another object to which it is connected by other objects in the data model. -
RecordAlertCategory
Represents a category to group and present record alerts. -
RegisteredExternalService
Represents a registered external service, which provides an extension or integration. -
ReferencedDashboard
Represents the ReferencedDashboard object in CRM Analytics. A referenced dashboard stores information about an externally referenced dashboard. -
RelatedRecordAssocCriteria
Represents criteria for automatically linking records like accounts, leads, opportunities, and cases with the branches that work with them. -
RelationshipGraphDefinition
Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works. -
RemoteSiteSetting
Represents a remote site setting. Before any Visualforce page, Apex callout, or JavaScript code using XmlHttpRequest in an s-control or custom button can call an external site, that site must be registered in the Remote Site Settings page, or the call fails. -
Report
Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported. -
ReportType
Represents the metadata associated with a custom report type. Custom report types allow you to build a framework from which users can create and customize reports. -
RestrictionRule
Represents a restriction rule or a scoping rule. A restriction rule has enforcementType set to Restrict and controls the access that specified users have to designated records. A scoping rule has enforcementType set to Scoping and controls the default records that your users see without restricting access. This type extends the Metadata metadata type and inherits its fullName field. -
RetrievalSummaryDefinition
Represents a metadata type that stores the header information of a retrieval definition. It enables the configuration of data retrieval patterns for summarizing related records across object relationships. -
Role
Represents a role in your organization. -
RoleOrTerritory
Represents the common base type and valid values for role or territory. -
RpaRobotPoolMetadata
Reserved for future use. -
SalesWorkQueueSettings
Represents settings used to customize work queue options for third-party scoring. In Sales Engagement, you can add a custom number field on person accounts, contacts, or leads. Then, use the custom number field to sort the work queue. This type extends the Metadata metadata type and inherits its fullName field. -
SamlSsoConfig
Represents a SAML Single Sign-On configuration. This type extends the Metadata metadata type and inherits its fullName field. Single sign-on (SSO) is an authentication method that enables users to access multiple applications with one login and one set of credentials. For example, after users log in to your org, they can automatically access all apps from the App Launcher. You can set up your Salesforce org to trust a third-party identity provider to authenticate users. Or you can configure a third-party app to rely on your org for authentication. -
SchedulingObjective
Represents a scheduling objective in Workforce Engagement. Scheduling objectives define business goals that the scheduling tools consider when identifying agents for shifts. -
SchedulingRule
Represents a scheduling rule in Workforce Engagement Management. Scheduling rules determine when agents are assigned to shifts. -
Scontrol
Deprecated. Represents an Scontrol component, corresponding to an s-control in the Salesforce user interface. -
SearchCustomization
Represents the configuration of search settings created in Search Manager. The configuration includes the search channel, searchable objects and fields, and rules to filter search results. -
SearchOrgWideObjectConfig
Represents an object in the search index. The search index contains org-wide search settings created in Search Manager. Each object in the search index includes searchable fields and fields protected by field-level security in search. -
ServiceAISetupDefinition
Represents settings for an Einstein for Service feature such as Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field. -
ServiceAISetupField
Represents a field on cases or knowledge articles that Einstein uses to identify relevant articles in Einstein Article Recommendations. This type extends the Metadata metadata type and inherits its fullName field. -
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. This type extends the Metadata metadata type and inherits its fullName field. -
ServiceProcess
Represents a process created in Service Process Studio and its associated attributes. -
Settings
Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type. -
SharedTo
SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules. -
SharingBaseRule
Represents sharing rule settings such as access level and to whom access is granted. -
SharingRules
Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group. -
SharingSet
Represents a sharing set. A sharing set defines an access mapping that grants portal or community users access to objects that are associated with their accounts or contacts. -
SiteDotCom
Represents a site for deployment. -
Skill
Represents the settings for a skill used for field service or to route chats to agents in Chat, such as the name of the skill and which agents the skills are assigned to. -
StandardValueSet
Represents the set of values in a standard picklist field. This type extends the Metadata metadata type and inherits its fullName field. -
StandardValueSetTranslation
Contains details for a standard picklist translation. It returns a translated standard value set.This type extends the Metadata metadata type and inherits its fullName field. -
StaticResource
Represents a static resource file, often a code library in a ZIP file. Static resources allow you to upload content that you can reference in a Visualforce page, including archives (such as .zip and .jar files), images, style sheets, JavaScript, and other files. Static resources can be used only within your Salesforce org, so you can’t host content here for other apps or websites. -
StageAssignment
Represents a collection of fields to automatically assign stage definitions to records based on rule criteria. -
StageDefinition
Represents a collection of fields to set up the states and transitions for Stage Management. -
SustainabilityUom
Represents the unit of measure (UOM) values for custom fuel types in an org. Track fuel consumption and emission results with the flexibility to add custom fuel types and UOM values. -
SustnUomConversion
Represents information about the unit of measure (UOM) conversion for the custom fuel types defined by a customer in an org. -
SvcCatalogCategory
Represents the grouping of individual catalog items in Service Catalog. -
SvcCatalogFulfillmentFlow
Represents the flow associated with a specific catalog item in the Service Catalog. -
SvcCatalogItemDef
Represents the entity associated with a specific, individual service available in the Service Catalog. -
SynonymDictionary
Represents a set of synonym groups, which are groups of words or phrases that are treated as equivalent in users’ searches. You can define synonym groups to optimize search results for acronyms, variations of product names, and other terminology unique to your organization. -
Territory
Represents a territory. -
Territory2
Represents the metadata associated with a sales territory. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled. -
Territory2Model
Represents the metadata associated with a territory model in Sales Territories. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled. -
Territory2Rule
Represents the metadata associated with a territory assignment rule associated with an object, such as Account. Available if Sales Territories has been enabled. -
Territory2Type
Represents the metadata for a category of territories in Sales Territories. Every Territory2 must have a Territory2Type. This type extends the Metadata metadata type and inherits its fullName field. Available if Sales Territories has been enabled. -
TimelineObjectDefinition
Represents the container that stores the details of a timeline configuration. You can use this resource with Salesforce objects to see their records' related events in a linear time-sorted view. -
TimeSheetTemplate
Represents a template for creating time sheets in Field Service. This type extends the Metadata metadata type and inherits its fullName field. -
TopicsForObjects
Represents the ability to assign topics to objects or to remove topic assignments. -
TransactionSecurityPolicy
Represents a transaction security policy definition. Transaction security policies give you a way to look through events in your organization and specify actions to take when certain combinations occur. -
Translations
Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench. -
UiFormatSpecificationSet
Represents a set of rules that define the style and visibility of conditional field formatting on Dynamic Forms-enabled Lightning page field instances. -
UIObjectRelationConfig
Represents the admin-created configuration of the object relation UI component. -
UiPreviewMessageTabDef
Represents the registration of a custom Marketing Cloud Preview and Test modal tab, created using custom Lightning web components. You can register and show multiple tabs in the Preview and Test experience. -
UserAccessPolicy
Represents a user access policy. -
UserAuthCertificate
Represents a PEM-encoded user certificate. These certificates are associated with a user, and externally uploaded. The uploaded certificate is used to authenticate the user. -
UserCriteria
Represents the member criteria to use in Experience Cloud site moderation rules. This type extends the Metadata metadata type and inherits its fullName field.. -
UserProfileSearchScope
Reserved for internal use. -
UserProvisioningConfig
Represents information to use during a user provisioning request flow, such as the attributes for an update. This type extends the Metadata metadata type and inherits its fullName field. -
VirtualVisitConfig
Represents an external video provider configuration, which relays events from Salesforce to the provider. -
WaveAnalyticAssetCollection
Represents a collection of Analytics assets. This type extends the Metadata metadata type and inherits its fullName field. -
WaveApplication
Represents the Analytics application. This type extends the Metadata metadata type and inherits its fullName field. -
WaveComponent
Represents the WaveComponent object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields. -
WaveDataflow
Represents the WaveDataflow object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields. -
WaveDashboard
Represents the WaveDashboard object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields. -
WaveDataset
Represents the WaveDataset object in the Analytics application. This type extends the Metadata metadata type and inherits its fullName field. -
WaveLens
Represents the WaveLens object in the Analytics application. -
WaveRecipe
Represents the WaveRecipe type in an Analytics application. A recipe is a saved set of steps to perform on a specific source dataset or connected data. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields. -
WaveTemplateBundle
Represents an Analytics template bundle, which can be used to create Analytics apps. A bundle contains an Analytics template definition and all its related resources.This type extends the Metadata metadata type and inherits its fullName field. -
WaveXmd
Represents the WaveXmd object in the Analytics application. This type extends the Metadata metadata type and inherits its fullName field. -
WebStoreBundle
For internal use only. -
WebStoreTemplate
Represents a configuration for creating commerce stores. -
Workflow
Represents the metadata associated with a workflow rule. A workflow rule sets workflow actions into motion when its designated conditions are met. You can configure workflow actions to execute immediately when a record meets the conditions in your workflow rule, or set time triggers that execute the workflow actions on a specific day. Use this metadata type to create, update, or delete workflow rule definitions. -
WorkSkillRouting
Represents a setup object that stores a set of WorkSkillRoutingAttribute objects. These objects are used to route a work item to an agent who has the skills necessary to take the work. This type extends the Metadata metadata type and inherits its fullName field.