NameSettings

Enables or disables the formal name, middle name, and suffix attributes for these person objects: Contact, Lead, Person Account, and User.

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

You can’t enable local name fields programmatically via the Metadata API. For more information about enabling local fields, see Local Name Fields and Enable ‘Local Name’ Fields.

This type extends Metadata and inherits its fields.

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

Introduced in API version 31.0.

• Type: boolean
• Required: No
• Introduced: API version 48.0
• Description: Reserved for internal use.

• Type: boolean
• Required: No
• Description: Indicates whether middle names are enabled (true) or disabled (false) for person objects.

• Type: boolean
• Required: No
• Description: Indicates whether suffixes are enabled (true) or disabled (false) for person objects.

This example shows a NameSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<NameSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableMiddleName>true</enableMiddleName>
4    <enableNameSuffix>false</enableNameSuffix>
5</NameSettings>

This example package.xml manifest references the NameSettings definitions.

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

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.