Newer Version Available

This content describes an older version of this product. View Latest

AccountSettings

Represents an org’s account settings for account teams, account owner report, and the View Hierarchy link. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for more details.

File Suffix and Directory Location

AccountSettings values are stored in the Account.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

AccountSettings is available in API versions 29.0 and later.

Fields

Field Name Field Type Description
enableAccountHistoryTracking boolean Indicates whether history tracking is enabled for accounts (true) or not (false). The default value is false. If history tracking is disabled, the History related list is removed from account page layouts. However, history data is still available for reporting up to the date and time when tracking was disabled. Available in API version 47.0 and later.
enableAccountOwnerReport boolean Indicates whether Account Owner Report can (true) or can’t (false) be run by all users.
enableAccountInsightsInMobile boolean Indicates whether users can see Einstein Account Insights on their mobile device (true) or not (false). Insights appear in the Einstein Insights component, which is on account records and the Home page.

Available in API version 47.0 and later.

To use this feature, users must have the Einstein Account Insights permission.
enableAccountTeams boolean Indicates whether account teams are enabled (true) or not (false).

The Metadata API can’t be used to disable account teams.

enableContactHistoryTracking boolean Indicates whether history tracking is enabled for contacts (true) or not (false). Available in API version 46.0 and later.
enableRelateContactToMultipleAccounts boolean Indicates whether users can relate a contact to multiple accounts (true) or only one account (false). The default value is false. If this feature (Contacts to Multiple Accounts) is disabled, secondary contact–account relationships created while the feature was enabled are deleted. Available in API version 47.0 and later.
showViewHierarchyLink boolean Indicates whether the default View Hierarchy link on all business account detail pages is visible (true) or hidden (false).

Declarative Metadata Sample Definition

The following is an example of the Account.settings file:

1<?xml version="1.0" encoding="UTF-8"?>
2<AccountSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableAccountOwnerReport>true</enableAccountOwnerReport>
4	<enableAccountTeams>true</enableAccountTeams>
5	<enableAccountInsightsInMobile>true</enableAccountInsightsInMobile>
6	<enableContactHistoryTracking>true</enableContactHistoryTracking>
7	<showViewHierarchyLink>true</showViewHierarchyLink>
8</AccountSettings>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Account settings metadata:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3	<types>
4		<members>Account</members>
5		<name>Settings</name>
6	</types>
7	<version>29.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.