---
schema_version: "1"
id: d5474f4c4f3dd6339722df590532e1e2d862ecb19b258d91c1a5b9b45fa3bca1
title: CustomAddressFieldSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_customaddressfieldsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customaddressfieldsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4aceeab2c611fad0eae04d165482c01f2fbeeb53ab903bb830a57f3bfc17b0f0
description: Represents the settings for custom address fields.
---
# CustomAddressFieldSettings

Represents the settings for custom address fields.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

CustomAddressFieldSettings values are stored in the CustomAddressField.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

CustomAddressFieldSettings components are available in API version 55.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d299632e119">Field Name</th>

              <th class="featureTableHeader  " id="d299632e122">Field Type</th>

              <th class="featureTableHeader  " id="d299632e125">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d299632e119" data-title="Field Name"><span class="keyword parmname">enableCustomAddressField</span></td>

              <td class="entry" headers="d299632e122" data-title="Field Type">boolean</td>

              <td class="entry" headers="d299632e125" data-title="Description">Indicates whether the <samp class="codeph nolang">Address</samp>
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_field_types.htm" title="These field types extend the field types described in the Salesforce Object Reference.">Field Type</a> is available
                for custom fields (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). The default value
                is <samp class="codeph nolang">false</samp>.<p class="p">Custom Address
                  Fields can’t be disabled. When
                  <span class="keyword parmname">enableCustomAddressField</span> is set to
                  <samp class="codeph nolang">true</samp>, you can’t change
                  the value to <samp class="codeph nolang">false</samp>.
                </p>
                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Before you set this field to <samp class="codeph nolang">true</samp>, review <a class="xref" href="https://help.salesforce.com/s/articleView?id=platform.fields_caf_requirements.htm&amp;type=5&amp;language=en_US" target="_blank">Custom Address Fields
                              Requirements and Limitations</a> in Salesforce
                            Help.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a CustomAddressFieldSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<CustomAddressFieldSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableCustomAddressField\>true</enableCustomAddressField\>
</CustomAddressFieldSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>CustomAddressField</members\>
        <name\>Settings</name\>
    </types\>
    <version\>55.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").