ActionOverride: Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can access ActionOverride only by accessing its encompassing CustomObject.
CustomField: Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.
CustomObject: Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.
Deploying and Retrieving Metadata with the Zip File: The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.
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.
AffinityScoreDefinition: Represents the affinity information used in calculations to analyze and categorize contacts for marketing purposes.
Sample package.xml Manifest Files: This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if you want to work with all the metadata in one batch.
WorkDotComSettings: Represents WorkDotCom settings. This type extends the Metadata metadata type and inherits its fullName field.
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.
AccountingSettings: Represents the settings for the Accounting Subledger feature.
AccountInsightsSettings: Represents an org’s Einstein Account Insights settings. This setting controls features that help your reps maintain their relationships with their customers.
AccountIntelligenceSettings: Represents an org’s Account Intelligence settings. These settings control features that make it easy for sales reps to create accounts, see relevant news articles, and add logos to account records. This type extends the Metadata metadata type and inherits its fullName field.
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.
AccountPlanSettings: Represents an org’s account plan settings. These settings control features that make it easy for sales reps to set objectives with actionable metrics and to store account research and analysis.
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.
AccountSettings: Represents an org’s account settings for account teams, account owner report, and the View Hierarchy link.
ActionableListDefinition: Represents the data source definition details associated with an actionable list.
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.
ActionsSettings: Represents an org’s actions settings for default quick actions, multi-dimensional publisher, and third-party actions. This type extends the Metadata metadata type and inherits its fullName field.
ActivationPlatform: Represents the ActivationPlatform configuration, such as platform name, delivery schedule, output format, and destination folder.
ActivationPlatformActvAttr: Represents the information about activation attributes. Reserved for future use.
ActivationPlatformField: Represents the information about the fields used in ActivationPlatform.
ActivitiesSettings: Represents an org's activity settings, and its user interface settings for the calendar. This type extends the Metadata metadata type and inherits its fullName field.
ActvPlatformAdncIdentifier: Represents the information about the identifiers to be activated, such as Email, Phone, Mobile Advertiser (MAID) ID, and Over-the-top (OTT) ID.
AddressSettings: Represents the configuration of country/territory and state picklists. Use the AddressSettings component type to configure state and country/territory data in your organization so that you can convert text-based values into standard picklist values. To convert your state and country/territory values, from Setup, enter State and Country/Territory Picklists in the Quick Find box, then select State and Country/Territory Picklists.
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.
AiAgentDefinition: Represents an Agentforce agent and the settings that apply to all its versions, such as its type and its context variables. Each version of the agent is a separate AiAgentDefinitionVersion component. For information about retrieving and deploying an Agentforce agent, see Use Use Metadata to Move an Agent to a New Org.
AiAgentDefinitionVersion: Represents a version of an Agentforce agent definition, conversation variables, planner configuration, and behavior settings. For information about retrieving and deploying an Agentforce agent, see Use Use Metadata to Move an Agent to a New Org.
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.
AiPlannerVoiceDef: Represents a voice definition for an Agentforce voice agent. It stores the speech-to-text and text-to-speech configuration settings used during voice interactions, including model selection, voice persona, and audio synthesis parameters.
AiPluginUtteranceDef: Represents an utterance that can be used to pick a topic during runtime.
AIReplyRecommendationsSettings: Represents the metadata used to manage settings for Einstein Reply Recommendations. This type extends the Metadata metadata type and inherits its fullName field.
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.
AllOrNoneHeader: Indicates whether to roll back all metadata changes when some of the records in a call result in failures.
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.
AnalyticsSettings: Represents Analytics settings in Salesforce. CRM Analytics lets you explore all your data quickly and easily by providing AI-powered advanced Analytics right inside Salesforce. Manage your datasets, query data with Salesforce Analytics Query Language (SAQL), and customize dashboards. You can use these settings to configure which Analytics features are available to users in your organization.
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.
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.
ApexSettings: Represents Apex-related org settings. This type extends the Metadata metadata type and inherits its fullName field.
SharingReason: Represents an Apex sharing reason, which is used to indicate why sharing was implemented for a standard or custom object. Apex managed sharing allows developers to use Apex to programmatically share custom objects. When you use Apex managed sharing to share an object, only users with the “Modify All Data” permission can add or change the sharing on the object's record, and the sharing access is maintained when the record owner changes or is deactivated. Sharing reasons for standard objects are available for objects that have a corresponding share object (for example, AccountShare, OpportunityShare) and whose org-wide default can be set to Private or Public Read-Only. Objects on the detail side of a master-detail relationship, which have no share object of their own, aren't supported.
SharingRecalculation: Represents Apex classes that recalculate the Apex managed sharing for a specific custom object.
ApexTestSuite: Represents a suite of Apex test classes to include in a test run.
API End-of-Life Policy: See which Metadata REST and SOAP API versions are supported, unsupported, or unavailable.
AppAnalyticsSettings: Represents settings to retrieve AppExchange App Analytics usage data.
AppExperienceSettings: Represents settings for the app experience.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.
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.
ArticleType: Represents the metadata associated with an article type.
ChannelLayout: Represents the metadata associated with a communication channel layout. Communication channel layouts let admins share article content inline into communication channels (for example, in email publishers, Experience Builder sites, or social media publishers). Admins can create a list of fields for an article type or record type that they want to share for each communication channel. You can customize the order of the fields.
ArticleType CustomField: Represents the metadata associated with an article type custom field. Use this metadata type to create, update, or delete article type custom field definitions.
ArticleType Layout: Represents the metadata associated with an article type page layout. Article type layouts determine which fields users can view and edit when entering data for an article. Article type layouts also determine which sections appear when users view articles.
AssessmentQuestion: Represents the container object that stores the questions required for an assessment.
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.
AssociationEngineSettings: Represents the record association builder settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
AsyncResult: Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.
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.
AutomatedContactsSettings: Represents an org’s Einstein Automated Contacts settings. These settings let you find new contacts and opportunity contact roles. 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.
BaseSharingRule: This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.
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.
BotSettings: Represents an organization’s Einstein Bot settings, such as whether or not Einstein Bots is enabled. This type extends the Metadata metadata type and inherits its fullName field.
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.
BranchManagementSettings: Represents the branch management settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
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.
BusinessHoursSettings: Represents the metadata used to manage settings for business hours and holidays in entitlements, entitlement templates, campaigns, and cases. This type extends the Metadata metadata type and inherits its fullName field.
BusinessProcess: The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.
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.
CRUD-Based Metadata API Calls: Use the CRUD-based metadata calls to create, update, or delete setup and configuration components for your organization or application. These configuration components include custom objects, custom fields, and other configuration metadata. The metadata calls mimic the behavior in the Salesforce user interface for creating, updating, or deleting components. Whatever rules apply there also apply to these calls.
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.
CampaignSettings: Represents an org’s Campaign Influence, Einstein Attribution, Einstein Key Accounts, and campaign member settings. These features help you understand how your campaigns and accounts are affecting your opportunity pipeline.
cancelDeploy(): Cancels a deployment that hasn’t completed yet.
CancelDeployResult: Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.
CareLimitType: Defines the characteristics of limits on benefit provision.
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.
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.
CaseSettings: Represents an organization’s case settings, such as the default case owner, which case-related features are enabled, and which Classic email templates are used for various case activities. This type extends the Metadata metadata type and inherits its fullName field.
CaseSubjectParticle: Represents the Social Business Rules custom format for the Case Subject field on cases created from inbound social posts.
CatalogedApi: Represents an API brought into API Catalog for Salesforce from an external source.
CatalogedApiVersion: Represents a version of an API that is consumable in Salesforce using API Catalog.
CriteriaBasedSharingRule: This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingRules instead. Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables you to share records based on specific criteria.
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.
ChatterAnswersSettings: Represents the metadata used to manage settings for Chatter Answers.
ChatterEmailsMDSettings: Represents an org’s settings for Chatter email when Chatter is enabled. This type extends the Metadata metadata type and inherits its fullName field.
ChatterExtension: Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher.
ChatterSettings: Represents an org’s settings for their Chatter instance when Chatter is enabled for the org. This type extends the Metadata metadata type and inherits its fullName field.
checkDeployStatus(): Checks the status of declarative metadata call deploy().
checkRetrieveStatus(): Checks the status of the declarative metadata call checkRetrieveStatus() and returns the zip file contents.
checkStatus(): Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.
ChoiceList: Represents the Choicelist dropdown field that’s used for pre-chat.
ClaimFinancialSettings: Represents the configuration settings for Insurance Claim Financial Services.
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.
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.
CodeBuilderSettings: Represents Code Builder settings. This type extends the Metadata metadata type and inherits its fullName field.
CollectionsDashboardSettings: Represents an org’s settings to add the Collections Dashboard application to an org.
CommerceSettings: Represents settings for various Commerce features.
CommunitiesSettings: Represents community settings for an org. Enable digital experiences and workspaces. Manage moderation, guest user and partner settings, and more. 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.
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.
CompactLayout: Represents the metadata associated with a compact layout. This type extends the Metadata metadata type and inherits its fullName field.
CompanySettings: Represents global settings that affect multiple features in your organization. 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.
ConnectedAppSettings: Represents settings for connected apps. This type extends the Metadata metadata type and inherits its fullName field.
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.
ContentSettings: Represents content settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
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.
ConversationalIntelligenceSettings: Represents the org's Einstein Conversation Insights settings, such as whether Einstein Conversation Insights is enabled. Einstein Conversation Insights lets you analyze your rep's call recordings, and gives you the insights you need to optimize every call.
ConversationChannelDefinition: Represents the conversation channel definition that’s implemented for Interaction Service for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS messaging channels. This object is available in API version 60.0 and later.
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.
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.
create(): Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.
createMetadata(): Adds one or more new metadata components to your organization synchronously.
CRUD-Based Calls: Use CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise WSDL act upon objects.
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.
CurrencySettings: Represents an organization's currency settings, including turning on multiple currencies, configuring active currencies, setting the corporate currency, and enabling currency effective dates. This type extends the Metadata metadata type and inherits its fullName field.
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.
CustomMetadata: Represents a record of a custom metadata type.
CustomNotificationType: Represents the metadata associated with a custom notification type.
CustomObjectTranslation: This metadata type allows you to translate custom objects for a variety of languages.
CustomPermission: Represents a permission that grants access to a custom feature. This type extends the Metadata metadata type and inherits its fullName field.
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.
Data 360 Metadata Types: Check out the metadata types that are used for development in Data 360.
DataKitObjectDependency: Represents the dependency between two data kit objects. The object templates are added inside the data kit.
DataKitObjectTemplate: Represents the object in Data Kit Object Template. These object templates are added inside the data kit.
DataMaskPolicy: Represents a masking policy for use with Data Mask & Seed.
DataMaskSettings: Represents org-level setup (features and preferences) for use with Data Mask & Seed.
DataObjectBuildOrgTemplate: Represents the derived object template used to define the structure and configuration of data objects in a build organization. The object templates are added inside the data kit to deploy metadata.
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.
DataPackageKitDefinition: Represents the top-level data kit container definition. Content objects can be added after the data kit is defined.
DataPackageKitObject: Represents the object in Data Kit Content Object. These objects are added inside the data kit.
DataSource: Used to represent the system where the data was sourced. This object is always needed when creating a Data Stream Definition.
DataSrcDataModelFieldMap: Represents the mappings between source data lake object (DLO) fields and target data model object (DMO) fields.
DataStreamDefinition: Contains data ingestion information such as connection, API, and file retrieval settings.
DataStreamTemplate: Represents the data stream that a user adds to a data kit.
DataWeaveResource: Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. DataWeave scripts can be directly invoked from Apex.
DebuggingHeader: Specifies that the deployment result contains the debug log output, and specifies the level of detail included in the log. The debug log contains the output of Apex tests that are executed as part of a deployment.
DebugLevel: Represents a set of log category levels to assign to a TraceFlag object. Multiple trace flags can use a debug level.
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.
DelegateGroup: Represents a group of users who have the same administrative privileges. These groups are different from public groups used for sharing.
delete(): Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use deleteMetadata() instead.
deleteMetadata(): Deletes one or more metadata components from your organization synchronously.
DeleteResult: Contains result information for the deleteMetadata call.
deploy(): Uses file representations of components to create, update, or delete those components in a Salesforce org.
deployRecentValidation(): Deploys a recently validated component set without running Apex tests.
Does a Retrieve Job Have a Status of Pending?: If you initiate several concurrent retrieve operations for a single org, Metadata API automatically puts some of those jobs in a queue, if that becomes necessary for service protection. If a retrieve job has a status of Pending, it’s in the queue. When one of the active retrieve jobs completes, Metadata API takes a pending job from the queue and activates it. If a retrieve job has a status of InProgress, it’s active. The process repeats until the job queue is cleared.
Deleting Components from an Organization: To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call performs the deletions first.
Run the Same Tests in Sandbox and Production Deployments: Starting in API version 34.0, you can choose which tests to run in your development environment, such as only local tests, to match the tests run in production. In earlier versions, if you enabled tests in your sandbox deployment, you couldn’t exclude managed package tests.
Run Relevant Apex Tests in a Deployment (Beta): Use the RunRelevantTests (beta) test level to run only the Apex tests that are relevant to your deployment. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies.
Running a Subset of Tests in a Deployment: Test levels enable you to have more control over which tests are run in a deployment. To shorten deployment time to production, run a subset of tests when deploying Apex components. The default test execution behavior in production has also changed. By default, if no test level is specified, no tests are executed, unless your deployment package contains Apex classes or triggers.
Running Tests in a Deployment: Learn default test execution rules for Salesforce production deployments, including API version differences and Apex test requirements.
Slow Deployments: If a file-based Metadata API deployment occurs during server downtime, such as a Salesforce service upgrade, the deployment can take longer than expected. This behavior happens because both component deployment and validation are retried from the beginning after the service is restored. However, if Apex tests were part of the deployment, only tests that weren’t run before the downtime are run.
DeploymentSettings: Represents the settings affecting how deployments behave in the org. This type extends the Metadata metadata type and inherits its fullName field.
DeployResult: Contains information about the success or failure of the associated deploy() call.
describeMetadata(): This call retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types.
describeValueType(): Retrieves the metadata describing a given metadata type (value type).
DescribeValueTypeResult: Contains information about a value type that’s useful for developers working with declarative metadata.
DescribeMetadataResult: Contains information about the organization that is useful for developers working with declarative metadata.
Metadata API Developer Tools: Use the Salesforce Extensions for Visual Studio Code on Salesforce CLI to access Metadata API commands. Salesforce CLI and the Salesforce Extensions for Visual Studio Code streamline the process of using Metadata API.
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.
DocumentGenerationSetting: Represents an org's settings for automatic document generation from templates. This type extends the Metadata metadata type and inherits its fullName field.
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.
EACSettings: Represents the Einstein Activity Capture metadata type. Use Einstein Activity Capture to add emails and events from your Microsoft or Google account to the activity timeline of related Salesforce records. Automatically sync contact and event data between your Microsoft or Google account and Salesforce. 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.
EinsteinAgentSettings: Represents settings for Einstein classification apps, Einstein Case Classification and Einstein Case Wrap-Up, in an org. This type extends the Metadata metadata type and inherits its fullName field.
EinsteinAISettings: Represents Einstein AI settings, including AI feedback integration with Data 360 and PII masking for AI trust features.
EinsteinGptSettings: Represents settings for Einstein Generative AI features in an org. This type extends the Metadata metadata type and inherits its fullName field
EmailAdministrationSettings: Represents an organization’s email administration settings, including email deliverability, security compliance, relay configurations, and system notifications. This type extends the Metadata metadata type and inherits its fullName field.
EmailAuthorizationSettings: Represents your org’s email authorization settings. This type extends the MetadataForSettings metadata type and inherits its fullName field.
EmailIntegrationSettings: Represents an org’s settings for the Outlook integration, Gmail integration, and Salesforce Inbox. This type extends the Metadata metadata type and inherits its fullName field.
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.
EmailTemplateSettings: Represents an org’s email template settings. This type extends the Metadata metadata type and inherits its fullName field.
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.
EmployeeUserSettings: Represents the employee-user settings used for automatically creating or syncing employee and user data in work.com orgs. 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.
EncryptionKeySettings: Represents an org’s encryption key settings, such as customer-supplied keys options and key derivation settings. This type extends the Metadata metadata type and inherits its fullName field.
EnhancedNotesSettings: Represents an org’s enhanced note settings, such as enabling enhanced notes and enabling tasks in enhanced notes.This type extends the Metadata metadata type and inherits its fullName field.
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.
Error: Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or deleteMetadata()) operation.
Error Handling: Metadata API calls return error information that your client application can use to identify and resolve runtime errors.
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.
EventSettings: Represents an org's platform event settings for Event Monitoring.
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.
ExperienceBundleSettings: Represents the org setting that enables the ExperienceBundle metadata type for Aura sites in Experience Cloud. The setting doesn’t affect LWR sites, which use ExperienceBundle by default. 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.
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.
ExternalAIModel: Represents the state of a given model for an Einstein for Service feature, such as Einstein Reply Recommendations.
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.
ExternalDataSource: Represents the metadata associated with an external data source. Create external data sources to manage connection details for integration with data and content that are stored outside your Salesforce org.
ExternalDataTranObject: Represents a definition of a Data 360 schema object. This type extends the Metadata metadata type and inherits its fullName field.
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.
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.
Metadata Field Types: These field types extend the field types described in the Salesforce Object Reference.
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.
FieldSet: Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's first name, middle name, last name, and business title.
FieldSrcTrgtRelationship: Stores the relationships between a data model object (DMO) and its fields. For example, the Individual.Id field has a one-to-many relationship (1:M) with the ContactPointEmail.PartyId field.
File-Based Calls: Use file-based calls to deploy or retrieve XML components.
FilesConnectSettings: Represents the settings that modify the Files Connect feature.This type extends the Metadata metadata type and inherits its fullName field.
FileUploadAndDownloadSecuritySettings: Represents the security settings for uploading and downloading files. 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.
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.
FlowSettings: Represents the Salesforce settings for processes and flows, such as whether Lightning runtime for flows is enabled.
FlowTest: Represents the metadata associated with a flow test. Before you activate a record-triggered, autolaunched, or Data Cloud-triggered flow, you can test it to verify its expected results and identify flow run-time failures.
FlowValueMap: Represents the metadata associated with creating a reusable entity for defining and managing mappings between source and target values used within a flow.
Folder: Represents a folder. This type extends the Metadata metadata type and inherits its fullName field.
FolderShare: Represents the settings for enhanced analytics folder sharing. Users can control access to reports or dashboards by giving others Viewer, Editor, or Manager access to the folder that contains the report or dashboard.
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.
ForecastingObjectListSettings: Represents an org’s forecasting object list settings. Use these settings to control which object types and field types appear in the list of object details on the forecasts page. For example, pipeline forecasts use the Opportunity object, and the object list settings specify which fields from that object are available in the opportunity list section of the forecasts page. This type extends the Metadata metadata type and inherits its fullName field.
ForecastingSettings: Represents the Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName field.
ForecastingSourceDefinition: Represents the object, measure, date type, and hierarchy that a forecast uses to project sales.
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.
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.
Headers: Use headers in Metadata API calls to set options for each call.
HelpSettings: Represents the org setting that changes the destination of help.salesforce.com to an alternative URL. Use this setting to deploy and retrieve the alternative Help URL.
HighVelocitySalesSettings: Represents an org’s Sales Engagement settings. With Sales Engagement, you can make your inside sales team as effective as possible.
HistoryRetentionPolicy: Represents the policy for archiving field history data. When you set a policy, you specify the number of months that you want to keep field history in Salesforce before archiving it. By default, when Field Audit Trail is enabled, all field history is retained.
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.
IdeasSettings: Represents the metadata used to manage settings for Ideas.
IdentityProviderSettings: Represents the settings used to enable or disable Salesforce as a SAML identity provider for single sign-on (SSO).
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.
IframeWhiteListUrlSettings: Represents settings related to the list of trusted external domains that you allow to frame your Visualforce pages or surveys. 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.
IncidentMgmtSettings: Represents settings for Customer Service Incident Management and Broadcast Communications.
Index: Represents an index defined within a custom big object. Use this metadata type to define the composite primary key (index) for a custom big object. This type extends the Metadata metadata type and inherits its fullName field.
IndustriesSettings: Represents settings for industries verticals such as Financial Services Cloud, Consumer Goods Cloud, Public Sector Solutions, Education Cloud, Salesforce Scheduler, Life Sciences Cloud, and Health Cloud.
InsPlcyLimitConsumptionRule: Represents configuration for how policy limit consumption rule applies to an insurance policy product, including consumption mode and product binding.
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.
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.
InterestTaggingSettings: Represents settings for Interest Tags, which your users can add to client records to capture client needs, interests, and prospecting opportunities.
Understanding Metadata API: Learn how the Salesforce Metadata API manages org configurations. Easily deploy, retrieve, and move customizations across orgs.
InventorySettings: Represents options for the Salesforce Omnichannel Inventory product.This type extends the Metadata metadata type and inherits its fullName field.
InvLatePymntRiskCalcSettings: Represents the org’s settings to identify the level of risks associated with payment of invoices.
InvocableActionExtension: Represents the configuration that defines how an action's inputs are presented in a user interface.
InvocableActionSettings: Represents the org’s invocable action settings, such as whether partial save is allowed.This type extends the Metadata metadata type and inherits its fullName field.
IPAddressRange: Represents a range of IP addresses to include in or exclude from the specified feature.
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.
KnowledgeSettings: Represents the metadata used to manage settings for Salesforce Knowledge.
LanguageSettings: Represents an organization’s language settings. Language settings control end-user language selection, locale formats, and translation options. This type extends the Metadata metadata type and inherits its fullName field.
Layout: Represents the metadata associated with a page layout. For more information, see Page Layouts in Salesforce Help.
LeadConfigSettings: Represents configuration settings for Leads that control how they are converted and displayed, and what actions are available. This type extends the Metadata metadata type and inherits its fullName field.
LeadConvertSettings: Represents an organization’s custom field mappings for lead conversion. Custom fields can be mapped from Leads to Accounts, Contacts, and Opportunities. Options for creating opportunities during lead conversion can also be specified. This type extends the Metadata metadata type and inherits its fullName field.
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.
LightningExperienceSettings: Represents the settings that modify an org’s Lightning Experience configuration. This type extends the Metadata metadata type and inherits its fullName field.
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.
listMetadata(): This call retrieves property information about metadata components in your organization. Data is returned for the components that match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField and RecordType.
ListMetadataQuery: The ListMetadataQuery parameter represents a list of objects that specify which components you are interested in.
ListView: ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects.
LiveAgentSettings: Represents an organization’s Chat settings, such as whether Chat is enabled. This type extends the Metadata metadata type and inherits its fullName field.
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.
MacroSettings: Represents an organization’s Macro settings, such as whether or not folders is enabled. This type extends the Metadata metadata type and inherits its fullName field.
MailMergeSettings: Represents the settings for Extended Mail Merge functionality.
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.
MarketingObject: A marketing object is a high-volume, low-latency custom object that stores data for personalizing content in your marketing campaigns. A marketing object supports a subset of CustomObject fields and uses the __mo suffix instead of __c.
MarketSegmentDefinition: Represents the field values for MarketSegmentDefinition. MarketSegmentDefinition is used to store the exportable metadata of a segment, such as segment criteria and other attributes. Developers can create segment definition packages, pass segment definition in the form of data build tool (DBT), and publish it on AppExchange for subscriber organizations to install and instantiate these segments.
MatchingRule: Represents a matching rule that is used to identify duplicate records.
MCETransformationsSettings: Controls Flow Builder's integration with Marketing Cloud Engagement (MCE), including sending contacts to MCE emails and journeys. This type extends the Metadata metadata type and inherits its fullName field.
Step 3 (Optional): Configure a Rule: To help the MCP server function optimally, you can create a rule that guides your AI assistant, such as Agentforce Vibes or Cursor Agent, to call the Metadata API Context MCP tools. An AI rule is a plain-text file like markdown that provides specific instructions, context, or constraints to your AI assistant.
Step 1: Configure an MCP Client: Configure a client to connect to MCP servers hosted in your Salesforce org. In this quick start guide, we provide guidance on how to configure Agentforce Vibes, Cursor, and Claude.The Agentforce Vibes extension is an AI-powered developer tool that's available as an easy-to-install Visual Studio Code extension.Cursor is an AI-driven coding editor that supports MCP. Claude is an AI assistant that you configure to connect to Salesforce Hosted MCP Servers. Configure Claude using a special Claude Desktop Extensions file.
Prerequisites: Set Up Salesforce Hosted MCP Servers: The Salesforce API Context MCP server is one of many Salesforce Hosted MCP Servers. To use the Salesforce API Context MCP server, you must first set up the Salesforce Hosted MCP Server.Activate the API Context MCP Server in your org.External client apps enable third-party applications to integrate with Salesforce using APIs and security protocols. You need an external client app if you’re using these tools with any MCP client other than Agentforce Vibes. Skip this step if you’re using the API Context tools in Agentforce Vibes.When you configure your MCP client and initiate its authentication, it opens a web browser to authenticate into your org via OAuth. To prepare for this, additional steps are sometimes needed for the authentication to succeed. Since the MCP spec doesn't have special provisions for systems like Salesforce with multiple tenants, we recommend the following steps:
MeetingsSettings: Represents the settings to enable Salesforce Meetings and the integration with Zoom video conferencing.
MessagingChannel: Represents the metadata associated with an Embedded Service Messaging channel.
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.
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.
MktDataTranObject: An entity that is used to deliver (aka transport) information from the source to a target (target will be called a landing entity).This can be the schema of a file, API, Event, or other means of transporting data, such as SubscriberFile1.csv, or SubscriberCDCEvent.
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.
MobileSettings: Represents an organization’s mobile settings. This type extends the Metadata metadata type and inherits its fullName field.
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.
MyDomainSettings: Represents your org’s My Domain settings. With My Domain, you can include your company name in your URLs, for example, https://yourcompanyname.my.salesforce.com. 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.
NameSettings: Enables or disables the formal name, middle name, and suffix attributes for these person objects: Contact, Lead, Person Account, and User. This type extends the Metadata metadata type and inherits its fullName field.
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.
ObjectLinkingSettings (Beta): Represents the channel-object linking settings for an org. This type extends the Metadata metadata type and inherits its fullName field.
Metadata Components and Types: Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass and CustomObject, which extend Metadata, the base class for all metadata types. A component is an instance of a metadata type.
ObjectSourceTargetMap: Contains the object-level mappings between the source and the target objects. The source and target objects can be an MktDataLakeObject or an MktDataModelObject. For example, an Email source object can be mapped to the ContactPointEmail object.
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.
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.
OpportunityInsightsSettings: Represents an org’s Einstein Opportunity Insights settings. This setting controls features that give you relevant updates about your opportunities.
OpportunityScoreSettings: Represents an org’s Einstein Opportunity Scoring settings, such as whether or not Einstein Opportunity Scoring is enabled. Einstein Opportunity Scoring helps determine the likelihood of an opportunity being won. This type extends the Metadata metadata type and inherits its fullName field.
OpportunitySettings: Represents org preferences for features such as automatic opportunity updates and similar-opportunity filters.
OrchestrationPlanCtxMapping: Represents the context mapping that Dynamic Revenue Orchestrator (DRO) uses to generate and orchestrate a plan for an object, such as a non-sales transaction for billing or another generic business process.
OrderManagementSettings: Represents options for the Salesforce Order Management product. This type extends the Metadata metadata type and inherits its fullName field.
OrgPreferenceSettings: Removed in API version 48.0. Represents the unique org preference settings in a Salesforce org.
OrgSettings: Represents the settings for org-wide functionality that isn’t associated with any specific feature.This type extends the Metadata metadata type and inherits its fullName field.
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.
OwnerSharingRule: Represents an ownership-based sharing rule. OwnerSharingRule enables you to share records owned by a set of users with another set, using rules that specify the access level of the target user group. This component is removed as of API version 33.0 and is available in earlier versions only.
Package: Specifies which metadata components to retrieve as part of a retrieve() call or defines a package of components.
PardotEinsteinSettings: Represents PardotEinsteinSettings. Use these settings to learn what factors drive your campaign performance, and get the best possible engagement score for your prospects. This type extends the Metadata metadata type and inherits its fullName field.
PardotSettings: Represents Marketing Cloud Account Engagement settings in your Salesforce org. Account Engagement, formerly known as Pardot, is a B2B marketing automation solution that helps you create meaningful connections, generate more pipeline, and close more deals. Use these settings to configure how Account Engagement collects and displays data.
PartyDataModelSettings: Represents an organization’s party data model settings, including options around the Individual object and consent enablement. This type extends the Metadata metadata type and inherits its fullName field.
PathAssistant: Represents Path records.This type extends the Metadata metadata type and inherits its fullName field.
PathAssistantSettings: Represents the Path preference setting. 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.
PaymentsSettings: Represents the Salesforce Payments settings when this feature is enabled for the org.
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: 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.
Picklist (Including Dependent Picklist): Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field in a standard object, such as an account.
PicklistSettings: Represents an org’s picklist settings. These settings control the behavior of a picklist. This type extends the Metadata metadata type and inherits its fullName field.
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.
PlatformEncryptionSettings: Represents an org’s Platform Encryption settings, such as settings for available encryption schemes, permissions, encryption policy access, and which fields can be encrypted. 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.
PlatformEventMigration: Represents configuration settings for a migration from standard volume platform events to high volume platform events.
PlatformEventSettings: Represents settings for platform events and change data capture events.
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.
PredictionBuilderSettings: Represents the settings that determine how a user can interact with Einstein Prediction Builder. This type extends the Metadata metadata type and inherits its fullName field.
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.
PrivacySettings: Represents an organization’s settings for data privacy and consent management. This type extends the Metadata metadata type and inherits its fullName field.
ProcessFlowMigration: Represents a process's migrated criteria and the resulting migrated flow.
ProductAttributeSet: Represents the ProductAttribute information being used as and attribute such as color_c, size_c .
ProductSettings: Represents organization preferences for quantity schedules, revenue schedules, and active flag interaction with prices. This type extends the Metadata metadata type and inherits its fullName field.
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.
ProfileSearchLayouts: Represents a user profile’s search results layouts for an object. ProfileSearchLayouts are similar to SearchLayouts. However, with profile-specific layouts, each user profile can have a different search results layout for an object.
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.
Build Client Applications for Metadata API: Use Metadata API to retrieve, deploy, create, update, or delete customizations for your org. The most common use is to migrate changes from a sandbox or testing org to your production environment. Metadata API is intended for managing customizations and for building tools that can manage the metadata model, not the data itself.
Quick Start: Metadata API: Get started with Metadata API by retrieving a small set of metadata components from your org on the Salesforce CLI.
Step 1: (Optional) Add Metadata Components to an Org Using the UI: If you’re starting with a new practice org that doesn’t have customizations, you only have standard metadata that can’t be retrieved. To use the Metadata API retrieve call, add a component on the Salesforce UI to your practice org. If you’re working on an existing project, you already have components to retrieve and can skip this step.
QuoteSettings: Represents an org’s quotes settings, such as enabling quotes or creating quotes without an associated opportunity. This type extends the Metadata metadata type and inherits its fullName field.
readMetadata(): Returns one or more metadata components from your organization synchronously.
ReadResult: Contains result information for the readMetadata call.
RealTimeEventSettings: Represents the list of Real-Time Event entities that you want to enable or disable. 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.
RecordPageSettings: Represents an org’s record page settings. This type extends the Metadata metadata type and inherits its fullName field.
RecordType: Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page layouts to different users. Use this metadata type to create, update, or delete record type definitions for a custom object.
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.
ReferencedDashboard: Represents the ReferencedDashboard object in CRM Analytics. A referenced dashboard stores information about an externally referenced dashboard.
RegisteredExternalService: Represents a registered external service, which provides an extension or integration.
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.
renameMetadata(): Renames a metadata component in your organization synchronously.
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.
Cancel a Deployment in Progress Using REST: You can request a cancellation of a deployment that's already in progress. Make the cancellation request by patching the status of an ongoing deployRequest. The cancellation is processed asynchronously. For API versions 65.0 and higher, deployments with a status of Finalizing Deploy, can't be cancelled. For API versions below 65.0, attempts to cancel a deployment may fail if the deployment has started committing data. Alternatively, it's possible that the cancellation will succeed, but data from the deployment is also committed.
Check the Status of Your Deployment Using REST Resources: Check the status of your deployment by using passing the deployment request ID in the URL The response body is similar to that returned by the original deployment request, but it includes information about the deployment in progress.
Deploy Metadata with REST API in Salesforce CLI: By default, the Salesforce CLI project deploy start command uses the Metadata SOAP API to deploy source to your org. You can use the Metadata REST API instead by setting a CLI configuration value or environment variable. Compared with SOAP API, REST API offers faster deployment.
REST Resources for Metadata: Use the REST resource deployRequest to move metadata (XML files) between a Salesforce organization and a local file system.
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.
retrieve(): The retrieve() call retrieves XML file representations of components in an organization.
RetrieveRequest: The RetrieveRequest parameter specified on a retrieve() call encapsulates options for determining which packages or files are retrieved.
RetrieveResult: The retrieve() call returns an array of RetrieveResult objects.
Metadata API Release Notes: Use the Salesforce Release Notes to learn about the most recent updates and changes to Metadata API.
Quick Start: Metadata API Context MCP Tools: The Metadata API Context MCP tools provide contextual information about Salesforce metadata types to help generate accurate Salesforce metadata files when working with the Metadata API.
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.
SandboxSettings: Represents Sandbox settings. This type extends the Metadata metadata type and inherits its fullName field.
SaveResult: Contains result information for the createMetadata, updateMetadata, or renameMetadata call.
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.
SchemaSettings: Represents an org’s schema settings, which manage the availability of custom settings and custom metadata type values. This type extends the Metadata metadata type and inherits its fullName field.
ScndTelephPrvdOtbdDtl: Represents the outbound SIP routing configuration for a secondary telephony provider in Agentforce Contact Center BYOC.
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.
SearchLayouts: Represents the metadata associated with the search layouts for an object. You can customize which fields to display for users in search results, search filter fields, lookup dialogs, and recent record lists on tab home pages. You can access SearchLayouts only by accessing its encompassing CustomObject.
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.
SecondaryTelephonyProvider: Represents the SIP configuration for secondary telephony providers in Agentforce Contact Center BYOC.
SecuritySettings: Represents an org’s security settings. For example, settings define trusted IP ranges for network access, password and login requirements, session expiration, and single sign-on settings.
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.
ServiceSetupAssistantSettings: Represents an organization’s Service Setup Assistant settings. The Service Setup Assistant can be used to set up a basic service console app.
SessionHeader: Specifies the session ID that the login call returns. This session ID is used to authenticate all subsequent Metadata API calls.
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.
SharingSettings: Represents an organization’s sharing, visibility, and data access settings. 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.
SiteSettings: Represents the settings for Experience Cloud sites and for Salesforce Sites.
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.
SocialCustomerServiceSettings: Represents Social Customer Service settings such as how to format inbound content from social posts to cases. This type extends the Metadata metadata type and inherits its fullName field.
SocialProfileSettings: Represents org preferences for social media features such as enabling Twitter and Facebook.Represents org preferences for social media features such as enabling Twitter and Facebook. This type extends the Metadata metadata type and inherits the fullName field.
SourceTrackingSettings (Beta): Represents settings for source tracking, so that changes you make in your Developer and Developer Pro sandboxes or local workspace can be tracked. This type extends the Metadata metadata type and inherits its fullName field.
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.
StreamingAppDataConnector: Represents the connection information specific to Web and Mobile Connectors.
SurveySettings: Represents an org’s survey settings. Use the SurveySettings component to enable Salesforce Surveys, enable Customer Lifecycle Maps, and choose whether the owner of a survey can manage the responses.
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.
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.
Tag: Represents a named label that can be applied to Salesforce metadata records to categorize, describe, or classify them. Tags are organized within a TagSet, which defines the category they belong to. For example, a TagSet named DataDomain might contain Tags such as Financial, Operational, or Legal. Use Tag to define the individual classification values available in a category.
TagSet: Represents a category that groups related Tag records. A TagSet defines the classification category, and its associated Tag records represent the individual values within that category. For example, a TagSet named DataDomain might group Tags such as Financial, Operational, or Legal. TagSets can be organized into a hierarchy, where a parent TagSet contains one or more child TagSets. This hierarchy allows you to make progressively granular classifications.
TelephonyProvider: Represents a telephony provider configuration that an org uses with Bring Your Own Carrier (BYOC).
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.
Territory2Settings: Represents an org’s Territory2 settings. Use Territory2 settings to set the access level that Sales Territories users have to records associated with sales territories, and to enable features. The standard record access settings apply to accounts and opportunities. With Private default internal access for contacts or cases, you can also set access for those records.
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.
TrailheadSettings: Represents an org’s integration with Trailhead for Learning Paths or Enablement programs, including access to enablement sites (formerly myTrailhead).
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.
TrialOrgSettings: Represents the settings in a trial user’s org. This type extends the Metadata metadata type and inherits its fullName field.
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.
TrustedTelephonyProvider: Represents the trusted telephony carrier configuration for Agentforce Contact Center BYOC.
Metadata Types: Metadata API enables you to access some entities and feature settings that you can customize in the user interface.
UIBundle: Represents the UI of a Salesforce Multi-Framework app, such as a React app.
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.
UiWidgetBundle (Beta): Represents a widget. Use widgets to define reusable UI compositions once and deploy them across supported Salesforce applications and third-party platforms. Deploy this bundle to your Salesforce org to make the widget available.
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.
update(): Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use updateMetadata() or renameMetadata() instead.
updateMetadata(): Updates one or more metadata components in your organization synchronously.
upsertMetadata(): Creates or updates one or more metadata components in your organization synchronously.
UpsertResult: Contains information about the result of the associated upsertMetadata() call.
Use Cases for Metadata API: Use Metadata API to move metadata between orgs during the development cycle. Metadata API is also used for deploying large metadata configuration changes from development.
Deploy Metadata to Production: In the final step of the development cycle, move customizations from a source control system such as Git into production with Metadata API.
Move Metadata from Production to Your Local File System: To make development changes without affecting your existing configurations, use Metadata API to move metadata to your local file system. Next, push metadata from your local file system to a shareable repository for development.
Move Metadata Changes to and from a Scratch Org: Use a scratch org to develop and test changes to metadata. You can perform your development within or outside the scratch org using Salesforce CLI or Salesforce Extensions for VS Code, which leverage the power of Metadata API.
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..
UserEngagementSettings: Represents the metadata associated with various feature settings around Lightning Experience transition and adoption, user engagement and adoption assistance, and adoption apps.
UserInterfaceSettings: Represents the settings that modify the behavior of the org’s user interface.
UserManagementSettings: Represents a selection of user management options that appear on the User Management Settings Setup page. This type extends the Metadata metadata type and inherits its fullName field.
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.
Utility Calls: Use utility calls to gather information that is useful for working with the file-based or CRUD-based calls.
ValidationRule: Represents a validation rule, which is used to verify that the data a user enters in a record is valid and can be saved. A validation rule contains a formula or expression that evaluates the data in one or more fields and returns a value of true or false. Validation rules also include an error message that your client application can display to the user when the rule returns a value of true due to invalid data.
VirtualVisitConfig: Represents an external video provider configuration, which relays events from Salesforce to the provider.
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.
VoiceSettings: Represents an org’s Sales Dialer settings, such as call recording, conferencing, and voicemail.
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.
WaveDashboard: Represents the WaveDashboard 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.
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.
WebLink: Represents a custom button or link defined in a custom object.
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.
Metadata: The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.
RetailExecutionSettings: Represents settings to manage your inventory, promotions, planograms, and in-store activities.
ObjectHierarchyRelationship: Represents an organization’s custom field mappings for sales agreement conversion. Fields can be mapped from Opportunity and Quotes to SalesAgreement and SalesAgreementProduct.
SalesAgreementSettings: Represents settings that control the display of agreement terms metrics in sales agreements and the calculation of the actual quantity of products in sales agreements. These settings also control the approval of sales agreements.
NamedFilter: Represents the metadata associated with a lookup filter. This metadata type is used to create, update, or delete lookup filter definitions. This component has been removed as of API version 30.0 and is only available in previous API versions. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.
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.
StandardValueSet Names and Standard Picklist Fields: In API version 38.0 and later, standard picklists are represented by the StandardValueSet type. In previous versions, standard picklists are represented by the CustomField type. This table lists the names of standard picklists as standard value sets and their corresponding field names.
