Metadata API Developer Guide
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Settings
Not all feature settings are available in the Metadata API. See Unsupported Metadata Types for information on which feature settings are not available.
<types>
<members>Security</members>
<name>Settings</name>
</types>
File Suffix and Directory Location
Each settings component gets stored in a single file in the settings directory of the corresponding package directory. The filename uses the format Setting feature.settings. For example, the SecuritySettings file would be Security.settings. See “File Suffix and Directory Location” information for the individual settings components to determine the exact filename.
Version
Settings is available in API version 27.0 and later. See the version information for the individual setting component to determine which API version the settings component became available.
Declarative Metadata Sample Definition
The following is an example package manifest used to deploy or retrieve only the MobileSettings for an organization:
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Mobile</members>
<name>Settings</name>
</types>
<version>27.0</version>
</Package>
The following is an example package manifest used to deploy or retrieve all the available settings metadata for an organization, using a wildcard:
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>Settings</name>
</types>
<version>27.0</version>
</Package>
-
AccountSettings
Represents an org’s account settings for account teams, account owner report, and the View Hierarchy link. -
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. -
AccountingSettings
Represents the settings for the Accounting Subledger feature. -
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. -
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. -
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. -
AIReplyRecommendationsSettings
Represents the metadata used to manage settings for Einstein Reply Recommendations. This type extends the Metadata metadata type and inherits its fullName field. -
AgentforceForDevelopersSettings
Represents Agentforce for Developers settings. -
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. -
ApexSettings
Represents Apex-related org settings. This type extends the Metadata metadata type and inherits its fullName field. -
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. -
AssociationEngineSettings
Represents the record association builder settings for an org. 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. -
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. -
BranchManagementSettings
Represents the branch management settings for an org. 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. -
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. 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. -
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. -
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. -
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. -
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. -
CompanySettings
Represents global settings that affect multiple features in your organization. This type extends the Metadata metadata type and inherits its fullName field. -
ConnectedAppSettings
Represents settings for connected apps. This type extends the Metadata metadata type and inherits its fullName field. -
ContentSettings
Represents content settings for an org. This type extends the Metadata metadata type and inherits its fullName field. -
ContractSettings
Represents contract settings. -
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. -
CurrencySettings
Represents an organization’s currency settings, including supporting multiple currencies and currency effective dates. This type extends the Metadata metadata type and inherits its fullName field. -
CustomAddressFieldSettings
Represents the settings for custom address fields. -
DataDotComSettings
Represents the org's Data.com settings. This type extends the Metadata metadata type and inherits its fullName field. -
DataImportManagementSettings
Represents an org's contact and leads import settings. -
DeploymentSettings
Represents the settings affecting how deployments behave in the org. This type extends the Metadata metadata type and inherits its fullName field. -
DevHubSettings
Represents Dev Hub settings. -
DocumentGenerationSetting
Represents an org's settings for automatic document generation from templates. This type extends the Metadata metadata type and inherits its fullName field. -
DynamicFormsSettings
Represents the settings related to Dynamic Forms. -
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. -
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. -
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. -
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. -
EmailTemplateSettings
Represents an org’s email template settings. 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. -
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. -
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. -
EntitlementSettings
Represents an organization’s entitlement settings. -
EventSettings
Represents an org's platform event settings for Event Monitoring. -
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. -
ExternalClientAppSettings
Represents settings to enable the External Client App feature and provide access to the OAuth consumer secret. -
ExternalServicesSettings
Represents settings for an External Services registration. -
FieldServiceSettings
Represents an organization’s Field Service settings. -
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. -
FlowSettings
Represents the Salesforce settings for processes and flows, such as whether Lightning runtime for flows is enabled. -
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. -
HighVelocitySalesSettings
Represents an org’s Sales Engagement settings. With Sales Engagement, you can make your inside sales team as effective as possible. -
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). -
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. -
IncidentMgmtSettings
Represents settings for Customer Service Incident Management and Broadcast Communications. -
IndustriesEinsteinFeatureSettings
Represents the settings for enabling the Industries Einstein feature. -
IndustriesLoyaltySettings
Represents the settings to enable capabilities of Loyalty Management. -
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. -
InterestTaggingSettings
Represents settings for Interest Tags, which your users can add to client records to capture client needs, interests, and prospecting opportunities. -
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. -
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. -
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. -
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. -
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. -
LightningExperienceSettings
Represents the settings that modify an org’s Lightning Experience configuration. This type extends the Metadata metadata type and inherits its fullName field. -
LiveMessageSettings
Represents an org’s LiveMessage settings. -
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. -
MapAndLocationSettings
Represents an org’s map and location settings. -
MeetingsSettings
Represents the settings to enable Salesforce Meetings and the integration with Zoom video conferencing. -
MobileSettings
Represents an organization’s mobile settings. 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. -
MfgServiceConsoleSettings
Represents the settings to access the Service Console for Manufacturing.This type extends the Metadata metadata type and inherits its fullName field. -
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. -
NotificationsSettings
Represents an organization’s mobile settings. -
OauthOidcSettings
Represents org settings for disabling OAuth OpenID Connect authorization flows. -
ObjectHierarchyRelationship
Represents an organization’s custom field mappings for sales agreement conversion. Fields can be mapped from Opportunity and Quotes to SalesAgreement and SalesAgreementProduct. -
ObjectLinkingSettings (Beta)
Represents the channel-object linking settings for an org. This type extends the Metadata metadata type and inherits its fullName field. -
OmniChannelSettings
Represents the Omni-Channel settings for an org. This type extends the Metadata metadata type and inherits its fullName field. -
OmniInteractionAccessConfig
Represents configuration settings for access to OmniStudio FlexCard caching and data sources. -
OmniInteractionConfig
Represents configuration settings for OmniStudio. -
OpportunityInsightsSettings
Represents an org’s Einstein Opportunity Insights settings. This setting controls features that give you relevant updates about your opportunities. -
OpportunitySettings
Represents org preferences for features such as automatic opportunity updates and similar-opportunity filters. -
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. -
OrderManagementSettings
Represents options for the Salesforce Order Management product. This type extends the Metadata metadata type and inherits its fullName field. -
OrderSettings
Represents order settings. -
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. -
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. -
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. -
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. -
PathAssistantSettings
Represents the Path preference setting. 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. -
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. -
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. -
PlatformEventSettings
Represents settings for platform events and change data capture events. -
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. -
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. -
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. -
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. -
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. -
RecordPageSettings
Represents an org’s record page settings. This type extends the Metadata metadata type and inherits its fullName field. -
RetailExecutionSettings
Represents settings to manage your inventory, promotions, planograms, and in-store activities. -
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. -
SandboxSettings
Represents Sandbox settings. This type extends the Metadata metadata type and inherits its fullName field. -
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. -
SearchSettings
Represents an org's search settings. -
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. -
ServiceCloudVoiceSettings
Represents an organization’s Service Cloud Voice settings. This type extends the Metadata metadata type and inherits its fullName field. -
ServiceSetupAssistantSettings
Represents an organization’s Service Setup Assistant settings. The Service Setup Assistant can be used to set up a basic service console app. -
SharingSettings
Represents an organization’s sharing, visibility, and data access settings. This type extends the Metadata metadata type and inherits its fullName field. -
SiteSettings
Represents the settings for Experience Cloud sites and for Salesforce Sites. -
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. -
SubscriptionManagementSettings
Represents the settings used to manage recurring subscriptions. -
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. -
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.This type extends the Metadata metadata type and inherits its fullName field. -
TrailheadSettings
Represents an org’s integration with Trailhead for Learning Paths or Enablement programs, including access to enablement sites (formerly myTrailhead). -
TrialOrgSettings
Represents the settings in a trial user’s org. 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. -
VoiceSettings
Represents an org’s Sales Dialer settings, such as call recording, conferencing, and voicemail. -
WarrantyLifeCycleMgmtSettings
Represents settings that control the Warranty Administration for your org. -
WorkDotComSettings
Represents WorkDotCom settings. This type extends the Metadata metadata type and inherits its fullName field. -
WorkforceEngagementSettings
Represents settings for Workforce Engagement Management.