Api Meta
DOWNLOAD
First things first !
To download this implementation guide, click the download button below.
If you need more information about the implementation guide, you can read the Table of Contents below.
Chapter Understanding Metadata API
Use Cases for Metadata API
Move Metadata from Production to Your Local File System
Move Metadata Changes to and from a Scratch Org
Move Metadata to a Sandbox at Integration Points
Deploy Metadata to Production
Move Metadata for ProductionLevel Changes
Make Large Metadata Configuration Changes
Release Notes
Metadata API Developer Tools
Supported Salesforce Editions
Metadata API Edit Access
Development Platforms
Standards Compliance
Metadata API Support Policy
API EndofLife Policy
Related Resources
Chapter Quick Start Metadata API
Prerequisites
Step Optional Add Metadata Components to an Org Using the UI
Step Build a Packagexml Manifest
Step Retrieve Components with Metadata API
Chapter Build Client Applications
USING METADATA API
Chapter Declarative FileBased Metadata API Calls
Deploying and Retrieving Metadata with the Zip File
Slow Deployments
Does a Retrieve Job Have a Status of Pending
Sample packagexml Manifest Files
Running Tests in a Deployment
Running a Subset of Tests in a Deployment
Run the Same Tests in Sandbox and Production Deployments
Maintaining User References
Chapter CRUDBased Metadata API Calls
Chapter REST Resources
Deploy Metadata with Apex Testing Using REST
Check the Status of Your Deployment Using REST Resources
Deploy a Recently Validated Component Set Without Tests
Cancel a Deployment in Progress Using REST
Deploy Metadata with REST API in Salesforce CLI
Chapter Error Handling
Error Handling for Session Expiration
REFERENCE
Chapter FileBased Calls
deploy
Deleting Components from an Organization
checkDeployStatus
cancelDeploy
deployRecentValidation
retrieve
RetrieveRequest
checkRetrieveStatus
Chapter CRUDBased Calls
createMetadata
readMetadata
updateMetadata
upsertMetadata
deleteMetadata
renameMetadata
create
delete
update
Chapter Utility Calls
checkStatus
describeMetadata
describeValueType
listMetadata
ListMetadataQuery
Chapter Result Objects
AsyncResult
CancelDeployResult
DeployResult
DescribeMetadataResult
DescribeValueTypeResult
ReadResult
RetrieveResult
SaveResult
DeleteResult
UpsertResult
Error
Chapter Metadata Types
Metadata Components and Types
Metadata Coverage Report
Unsupported Metadata Types
Special Behavior in Metadata API Deployments
Data Cloud Metadata Types
ActivationPlatform
ActivationPlatformField
ActvPfrmDataConnectorS
ActvPlatformAdncIdentifier
ActvPlatformFieldValue
DataConnectorIngestApi
DataConnectorS
DataPackageKitDefinition
DataPackageKitObject
DataSource
DataSourceBundleDefinition
DataSourceField
DataSourceObject
DataSrcDataModelFieldMap
DataStreamDefinition
DataStreamTemplate
ExternalDataConnector
ExternalDataSource
ExternalDataTranObject
FieldSrcTrgtRelationship
MarketSegmentDefinition
MktCalcInsightObjectDef
MktDataTranObject
ObjectSourceTargetMap
StreamingAppDataConnector
AccountRelationshipShareRule
AccountingFieldMapping
AccountingModelConfig
ActionLinkGroupTemplate
ActionPlanTemplate
ActionableListDefinition
AdvAccountForecastSet
AIApplication
AIApplicationConfig
AIScoringModelDefinition
AIUsecaseDefinition
AnalyticSnapshot
AnimationRule
ArticleType
ArticleType Layout
ChannelLayout
ArticleType CustomField
ApexClass
ApexComponent
ApexEmailNotifications
ApexPage
ApexTestSuite
ApexTrigger
AppMenu
AppointmentAssignmentPolicy
AppointmentSchedulingPolicy
ApprovalProcess
AssignmentRules
AssessmentQuestion
AssessmentQuestionSet
Audience
AuraDefinitionBundle
AuthProvider
AutoResponseRules
BatchCalcJobDefinition
BatchProcessJobDefinition
BlacklistedConsumer
Bot
BotBlock
BotTemplate
BotVersion
BrandingSet
BriefcaseDefinition
BusinessProcessGroup
CallCenter
CallCoachingMediaProvider
CampaignInfluenceModel
CaseSubjectParticle
CareBenefitVerifySettings
CareLimitType
CareSystemFieldMapping
CareProviderSearchConfig
CareRequestConfiguration
Certificate
ChatterExtension
ClaimFinancialSettings
ClauseCatgConfiguration
CleanDataService
CMSConnectSource
Community Zone
CommunityTemplateDefinition
CommunityThemeDefinition
ConnectedApp
ContentAsset
ContextDefinition
CorsWhitelistOrigin
CspTrustedSite
CustomApplication
CustomApplicationComponent
CustomFeedFilter
CustomHelpMenuSection
CustomIndex
CustomLabels
Custom Metadata Types CustomObject
CustomMetadata
CustomNotificationType
CustomObject
ActionOverride
BusinessProcess
CompactLayout
CustomField
FieldSet
HistoryRetentionPolicy
Index
ListView
NamedFilter
Picklist Including Dependent Picklist
ProfileSearchLayouts
RecordType
SearchLayouts
SharingReason
SharingRecalculation
ValidationRule
WebLink
Metadata Field Types
CustomObjectTranslation
CustomPageWebLink
CustomPermission
CustomSite
CustomTab
CustomValue
Dashboard
DataCategoryGroup
DataWeaveResource
DecisionTable
DecisionTableDatasetLink
DecisionMatrixDefinition
DelegateGroup
DigitalExperienceBundle
DigitalExperienceConfig
DisclosureDefinition
DisclosureDefinitionVersion
DisclosureType
DiscoveryAIModel
DiscoveryGoal
DiscoveryStory
Document
DocumentCategory
DocumentCategoryDocumentType
DocumentChecklistSettings
DocumentType
DuplicateRule
EclairGeoData
EmailServicesFunction
EmailTemplate
EmbeddedServiceBranding
EmbeddedServiceConfig
EmbeddedServiceFieldService
EmbeddedServiceFlowConfig
EmbeddedServiceLiveAgent
EmbeddedServiceMenuSettings
EntitlementProcess
EntitlementTemplate
EscalationRules
EventDelivery
EventRelayConfig
EventSubscription
ExperienceBundle
ExperiencePropertyTypeBundle Beta
ExplainabilityMsgTemplate
ExpressionSetDefinition
ExpressionSetObjectAlias
ExternalClientApplication
ExternalCredential
ExternalAIModel
ExternalServiceRegistration
ExtlClntAppConfigurablePolicies
ExtlClntAppGlobalOauthSettings
ExtlClntAppOauthConfigurablePolicies
ExtlClntAppOauthSettings
FeatureParameterBoolean
FeatureParameterDate
FeatureParameterInteger
FieldRestrictionRule
FlexiPage
Flow
FlowCategory
FlowDefinition
FlowTest
Folder
FolderShare
ForecastingFilter
ForecastingFilterCondition
ForecastingSourceDefinition
ForecastingType
ForecastingTypeSource
FuelType
FuelTypeSustnUom
FunctionReference
FundraisingConfig
GatewayProviderPaymentMethodType
GlobalPicklist
GlobalPicklistValue
GlobalValueSet
GlobalValueSetTranslation
Group
HomePageComponent
HomePageLayout
IdentityVerificationProcDef
IdentityVerificationProcDtl
IdentityVerificationProcFld
InboundCertificate
InboundNetworkConnection
InstalledPackage
IntegrationProviderDef
IPAddressRange
KeywordList
Layout
Letterhead
LightningBolt
LightningComponentBundle
LightningExperienceTheme
LightningMessageChannel
LightningOnboardingConfig
LiveChatAgentConfig
LiveChatButton
LiveChatDeployment
LiveChatSensitiveDataRule
LoyaltyProgramSetup
ManagedContentType
ManagedEventSubscription Beta
ManagedTopics
MarketingAppExtension
MatchingRule
MessagingChannel
Metadata
MetadataWithContent
MfgProgramTemplate
MilestoneType
MlDomain
MLDataDefinition
MLPredictionDefinition
MobileApplicationDetail
ModerationRule
MutingPermissionSet
MyDomainDiscoverableLogin
NamedCredential
NavigationMenu
Network
NetworkBranding
NotificationTypeConfig
OauthCustomScope
OcrSampleDocument
OcrTemplate
OmniExtTrackingDef
OmniScript
OmniSupervisorConfig
OmniTrackingGroup
OutboundNetworkConnection
Package
ParticipantRole
PathAssistant
PaymentGatewayProvider
PermissionSet
PermissionSetGroup
PermissionSetLicenseDefinition Developer Preview
PersonAccountOwnerPowerUser
PipelineInspMetricConfig
PlatformCachePartition
PlatformEventChannel
PlatformEventChannelMember
PlatformEventSubscriberConfig
Portal
PortalDelegablePermissionSet
PostTemplate
ProductAttributeSet
PresenceDeclineReason
PresenceUserConfig
Profile
ProfileActionOverride
ProfilePasswordPolicy
ProfileSessionSetting
Prompt
Queue
QueueRoutingConfig
QuickAction
RedirectWhitelistUrl
RecommendationStrategy
RecordActionDeployment
RecordAggregationDefinition
RecordAlertCategory
ReferencedDashboard
RelatedRecordAssocCriteria
RelationshipGraphDefinition
RemoteSiteSetting
Report
ReportType
RestrictionRule
Role
RoleOrTerritory
SalesWorkQueueSettings
SamlSsoConfig
SchedulingObjective
SchedulingRule
Scontrol
SearchCustomization
ServiceAISetupDefinition
ServiceAISetupField
ServiceChannel
ServicePresenceStatus
ServiceProcess
Settings
AccountSettings
AccountInsightsSettings
AccountIntelligenceSettings
AccountingSettings
ActionsSettings
ActivitiesSettings
AddressSettings
AIReplyRecommendationsSettings
AnalyticsSettings
ApexSettings
AppAnalyticsSettings
AppExperienceSettings
AssociationEngineSettings
AutomatedContactsSettings
BotSettings
BranchManagementSettings
BusinessHoursSettings
CampaignSettings
CaseSettings
ChatterAnswersSettings
ChatterEmailsMDSettings
ChatterSettings
CodeBuilderSettings
CommunitiesSettings
CompanySettings
ConnectedAppSettings
ContentSettings
ContractSettings
ConversationalIntelligenceSettings
CurrencySettings
CustomAddressFieldSettings
DataDotComSettings
DataImportManagementSettings
DeploymentSettings
DevHubSettings
DocumentGenerationSetting
DynamicFormsSettings
EACSettings
EinsteinAgentSettings
EmailAdministrationSettings
EmailIntegrationSettings
EmailTemplateSettings
EmployeeUserSettings
EnhancedNotesSettings
EncryptionKeySettings
EntitlementSettings
EventSettings
ExperienceBundleSettings
ExternalClientAppSettings
ExternalServicesSettings
FieldServiceSettings
FilesConnectSettings
FileUploadAndDownloadSecuritySettings
FlowSettings
ForecastingObjectListSettings
ForecastingSettings
HighVelocitySalesSettings
IdeasSettings
IdentityProviderSettings
IframeWhiteListUrlSettings
IndustriesEinsteinFeatureSettings
IndustriesLoyaltySettings
IndustriesSettings
InterestTaggingSettings
InventorySettings
InvocableActionSettings
KnowledgeSettings
LanguageSettings
LeadConfigSettings
LeadConvertSettings
LiveAgentSettings
LightningExperienceSettings
LiveMessageSettings
MacroSettings
MailMergeSettings
MapAndLocationSettings
MeetingsSettings
MobileSettings
MyDomainSettings
MfgServiceConsoleSettings
NameSettings
NotificationsSettings
OauthOidcSettings
OauthTokenExchangeHandler
ObjectHierarchyRelationship
ObjectLinkingSettings Beta
OmniChannelSettings
OmniInteractionAccessConfig
OmniInteractionConfig
OpportunityInsightsSettings
OpportunitySettings
OpportunityScoreSettings
OrderManagementSettings
OrderSettings
OrgPreferenceSettings
OrgSettings
PartyDataModelSettings
PardotSettings
PardotEinsteinSettings
PathAssistantSettings
PaymentsSettings
PicklistSettings
PlatformEncryptionSettings
PlatformEventSettings
PredictionBuilderSettings
PrivacySettings
ProcessFlowMigration
ProductSettings
QuoteSettings
RealTimeEventSettings
RecordPageSettings
RetailExecutionSettings
SalesAgreementSettings
SandboxSettings
SchemaSettings
SearchSettings
SecuritySettings
ServiceCloudVoiceSettings
ServiceSetupAssistantSettings
SharingSettings
SiteSettings
SocialCustomerServiceSettings
SocialProfileSettings
SourceTrackingSettings Beta
SurveySettings
TerritorySettings
TrailheadSettings
TrialOrgSettings
UserEngagementSettings
UserInterfaceSettings
UserManagementSettings
VoiceSettings
WarrantyLifeCycleMgmtSettings
WorkDotComSettings
WorkforceEngagementSettings
SharedTo
SharingBaseRule
SharingRules
BaseSharingRule
CriteriaBasedSharingRule
OwnerSharingRule
SharingSet
SiteDotCom
Skill
StandardValueSet
StandardValueSetTranslation
StaticResource
SustainabilityUom
SustnUomConversion
SvcCatalogCategory
SvcCatalogFulfillmentFlow
SvcCatalogItemDef
SynonymDictionary
Territory
Territory
TerritoryModel
TerritoryRule
TerritoryType
