Address as a Custom Field (Beta) Developer Guide

Address as a Custom Field (Beta) Developer Guide
Manage Custom Addresses as Component Fields (Beta)
Address as a Custom Field (Beta) Limitations
Configure State and Country Picklists
Apex Examples (Beta)
Metadata API Example (Beta)
REST API Examples (Beta)
SOAP API Examples (Beta)
Tooling API Examples (Beta)
PDF

Newer Version Available

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

Configure State and Country Picklists

Address as a Custom Field (Beta) uses picklists for the State and Country address fields. Before you add a custom field with the Address field type, configure State and Country/Territory picklists.
Available in: all editions except Database.com.

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Address as a Custom Field (Beta) has been enabled for a limited number of customers in Spring '22. Before creating a custom field of type Address, review the limitations.

Note

If State and Country/Territory picklists are enabled, those picklist values are used in standard address fields. With Address as a Custom Field (Beta), the same picklist values are automatically available in custom address fields. You can’t specify separate picklist values for standard and custom address fields.

If State and Country/Territory Picklists aren’t enabled, those picklists are enabled for custom address fields with Address as a Custom Field (Beta). By default, all countries, territories, and their states and provinces are visible to users. To specify the available picklist values in Salesforce, configure State and Country/Territory Picklists.

When you configure these picklist values, the behavior of standard address fields is unaffected unless you enable State and Country/Territory Picklists for standard fields through Setup. Enabling the picklists for standard fields isn’t required to use Address as a Custom Field (Beta).

To configure the picklists, use the AddressSettings Metadata API or see Configure State and Country/Territory Picklists in Salesforce Help.

For details on enabling the picklists for standard address fields, see Let Users Select States, Countries, and Territories from Picklists in Salesforce Help.