Salesforce API version
  • 01 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Dark
    Light

Salesforce API version

  • Dark
    Light

Article Summary

Overview

ARM's ability to support Salesforce Standard and Custom Objects is determined by the Salesforce API version used. ARM now supports the Salesforce API 57.0 version, which means it can support any Salesforce standard or custom object that requires Salesforce API version 57.0 or earlier.  

Important!!
Only users on an ARM shared instance will observe the changes since the Salesforce API version is being updated to 57.0 as part of weekly hotfixes to the shared instances only.

To identify which Salesforce API version you are on, please refer to the article: Find Salesforce Edition and API version.

Troubleshooting:
Ensure your Salesforce API version in ARM matches the API version of the Salesforce org. Failure to match the version may result in metadata object commit/deployment failure in your target environment.

Use Case:
  • API version set in ARM: 56.0
  • Salesforce Org API version: 57.0
When you use ARM to perform an EZ-Commit and choose the Flow and Flow Definition components from a Salesforce org, the properties 'triggerOrder' and 'Overridable' do not reflect in your target branch.
It fails when you try to deploy using the above revision after changing the API version to 57.0 in ARM.

You'll need to retrigger the commit and deployment process to make the deployment successful.

Salesforce API Supported Metadata Types

The below tables highlight the newly supported metadata types for each API version. 

API 57.0 newly Supported Metadata Types

OmniSupervisorConfigPipelineInspMetricConfigDataImportManagementSettings
HighVelocitySalesSettingsTerritory2AccessLevelAdvAccountForecastSet
Important Note:
OmniSupervisorConfig metadata type is not supported in Unlocked Package creation, but is working as expected in Commits and Deployments.

API 56.0 newly Supported Metadata Types

S. No.Metadata TypeFolder NameFile Extension
1AIUsecaseDefinitionaiUsecaseDefinitions.aiUsecaseDefinitions
2DigitalExperienceBundledigitalExperiences.digitalExperience
3DigitalExperienceConfigdigitalExperienceConfigs.digitalExperienceConfig
4EventRelayConfigeventRelays.eventRelay
5OauthOidcSettingssettings.settings
Troubleshooting
Ensure that your Salesforce API version in ARM matches the API version of the Salesforce org. Failure to match the version may result in errors while accessing the Salesforce org in Version Control, CI Jobs, Deployment, or SFDX modules.
Important Note:

The following fields have been deprecated on the NamedCredential metadata type in API version 56.0. These fields are valid only when namedCredentialType is null or set to Legacy.

  • authProvider
  • authTokenEndpointUrl
  • awsAccessKey
  • awsAccessSecret
  • awsRegion
  • awsService
  • certificate
  • endpoint
  • jwtAudience
  • jwtFormulaSubject
  • jwtIssuer
  • jwtSigningCertificate
  • jwtTextSubject
  • jwtValidityPeriodSeconds
  • oauthRefreshToken
  • oathScope
  • oathToken
  • outboundNetworkConnection
  • password
  • principalType
  • protocol
  • username

API 55.0 newly Supported Metadata Types

The newly supported metadata types are available on the Salesforce website, link: https://developer.salesforce.com/docs/atlas.en-us.pages.meta/pages/pages_intro_whats_new.htm

Troubleshooting:
Below is the list of the metadata types in the API 55.0 version that are not picked up during deployment or CI job operation:
  • ARMAssessmentQuestion
  • AssessmentQuestionSet
  • ForecastingFilterConditions
  • ForecastingFilters
  • ForecastingSourceDefinitions
  • ForecastingTypes
  • ForecastingTypeSources

API 54.0 newly Supported Metadata Types

S. No.Metadata TypeFolder NameFile Extension
1LoyaltyProgramSetuployaltyProgramSetups.loyaltyProgramSetup
2RecordAlertCategoryrecordAlertCategories.recordAlertCategory

API 53.0 Supported Metadata Types

Please refer here to find the list of supported Salesforce objects supported on Salesforce API 53.0 version.

API 52.0 newly Supported Metadata Types

S. No.Metadata TypeFile ExtensionFolder Name
1EinsteinAgentSettingsEinsteinAgent.settingssettings
2FieldRestrictionRule.rulefieldRestrictionRules
3ForecastingObjectListSettingsForecastingObjectList.settingssettings
4ForecastingSourceDefinition.forecastingSourceDefinitionforecastingSourceDefinitions
5ForecastingType.forecastingTypeforecastingTypes
6ForecastingTypeSource.forecastingTypeSourceForecastingTypeSources
7FunctionReference(Beta).functionsfunctions
8MktCalcInsightObjectDef.mktCalcInsightObjectDefmktCalcInsightObjectDefs
9OcrSampleDocument.ocrSampleDocumentocrSampleDocuments
10OcrTemplate.ocrTemplateocrTemplates
11RestrictionRule.rulerestrictionRules
12ServiceCloudVoiceSettingsServiceCloudVoice.settingssettings
13WorkforceEngagementSettingsWorkforceEngagement.settingssettings

API 51.0 newly  Supported Metadata Types

S. NoMetadata TypeFile SufixFolder Name
1BatchCalcJobDefinition.batchCalcJobDefinitionbatchCalcJobDefinitions
2BatchProcessJobDefinition.batchProcessJobDefinitionbatchProcessJobDefinitions
3CleanDataService.cleanDataServicecleanDataServices
4DecisionTable.decisionTabledecisionTables
5DecisionTableDatasetLink.decisionTableDatasetLinkdecisionTableDatasetLinks
6DuplicateRule.duplicateRuleduplicateRules
7FieldSrcTrgtRelationship.fieldSrcTrgtRelationshipfieldSrcTrgtRelationship
8ObjectSourceTargetMap.objectSourceTargetMapobjectSourceTargetMaps
9PlatformEventSubscriberConfig.platformEventSubscriberConfigPlatformEventSubscriberConfigs
10ServiceAISetupDefinition.serviceAISetupDescriptionserviceAISetupDescriptions
11ServiceAISetupField.serviceAiSetupFieldserviceAiSetupFields

API 49.0 newly Supported Metadata Types

Below is the list of API 49.0 metadata types supported for both Salesforce DX and non-DX platforms:

For versions 48.0 and earlier, please refer here to find the list of Salesforce objects and their supported API versions.




Was this article helpful?

What's Next