--- schema_version: "1" id: 9210d1509c9f7714d625502e2fddea79e31a1a42908e136bec6518719e4e2337 title: AddressSettings collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_addresssettings.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_addresssettings.htm source_site: developer.salesforce.com content_type: documentation content_hash: 715c1e589e81073e281648272559b8e43787f0d0937ecdf45eb95973a31aed27 description: 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. --- # 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**. 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 organization settings metadata types 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 details. ## Declarative Metadata File Suffix and Directory Location AddressSettings values are stored in a single file named Address.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component. ## Version AddressSettings is available in API versions 27.0 and later. ## Salesforce CLI Usage When working with the Salesforce CLI, use the metadata type Settings:Address to deploy or retrieve address settings. ## CountriesAndStates This complex metadata type represents valid definitions of states and countries/territories in picklists. | Field | Field Type | Description | | --- | --- | --- | | countries | Country\[\] | The countries and territories available in picklists. | ## Country This metadata type provides the definition for a country/territory in a picklist.
Field Field Type Description
active boolean Determines whether the value is available in the API.
Important

Important

After you enable state and country/territory picklists in your Salesforce organization, you can’t set the active status to false.

integrationValue string
A customizable text value that is linked to a state or country/territory code. Integration values for standard states, countries, and territories default to the full ISO-standard state, country, and territory names. Integration values function similarly to the API names of custom fields and objects. Configuring integration values allows integrations that you set up before enabling state and country/territory picklists to continue to work.
Important

Important

If you don’t specify integration values before enabling state and country/territory picklists in your organization, records use the default value provided by Salesforce. If you change integration values later, records created or updated from that point on use your edited values.
isoCode string The ISO-standard code populates this field when you issue a retrieve() call. You can’t edit the isoCode of standard states, countries, and territories.
label string The label is what users see in picklists in Salesforce.
orgDefault boolean Sets a country or territory as the default value for new records in the Salesforce organization.
standard boolean Standard states and countries are states and countries that are included with Salesforce. You can’t edit the standard attribute.
states State[] The states or provinces that are part of the country or territory.
visible boolean Makes the state, country, or territory available to users in Salesforce. States, countries, or territories that are visible must also be active.
## State This metadata type provides the definition for a state in a picklist.
Field Field Type Description
active boolean Determines whether the value is available in the API.
Important

Important

After you enable state and country/territory picklists in your Salesforce organization, you can’t set the active status to false.

integrationValue string
A customizable text value that is linked to a state or country/territory code. Integration values for standard states, countries, and territories default to the full ISO-standard state, country, and territory names. Integration values function similarly to the API names of custom fields and objects. Configuring integration values allows integrations that you set up before enabling state and country/territory picklists to continue to work.
Important

Important

If you don’t specify integration values before enabling state and country/territory picklists in your organization, records use the default value provided by Salesforce. If you change integration values later, records created or updated from that point on use your edited values.
isoCode string The ISO-standard code populates this field when you issue a retrieve() call.
label string The label is what users see in picklists in Salesforce.
standard boolean Standard states and countries are states and countries that are included with Salesforce. You can’t edit the standard attribute.
visible boolean Makes the state, country, or territory available to users in Salesforce. States, countries, or territories that are visible must also be active.
## Declarative Metadata Sample Definition The following is sample XML that configures state and country picklists for the United States and Canada for use in an organization. It also makes the country of Greenland available only in the API. This example is supported in API version 68.0. true United States US United States true true true Alabama AL Alabama true true true Alaska AK Alaska true true true true Canada CA Canada false true Alberta AB Alberta true true true British Columbia BC British Columbia true true true true Greenland GL Greenland true false ## 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.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).