Metadata API Developer Guide
jNewer Version Available
AccountSettings
Represents an organization’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 is 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 |
|---|---|---|
| enableAccountOwnerReport | boolean | Indicates whether Account Owner Report may (true) or may not (false) be run by all users. |
| enableAccountTeams | boolean | Indicates whether Account Teams are enabled (true) or not (false). The Metadata API cant’ be used to disable Account Teams. |
| 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 <showViewHierarchyLink>true</showViewHierarchyLink>
6</AccountSettings>Example Package Manifest
The following is an example package manifest used to deploy or retrieve the Account settings metadata for an organization:
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>