The address object representation and fields are described below.
address was introduced in API version V1
address has not been marked for deprecation
Postal or location address used by CRM and identity representation
{
"identity" : {
"urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
"url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
},
"officeBoxNumber" : "Google UK Ltd",
"street" : "71 Buckingham Palace Road",
"area" : "Belgravia",
"locality" : "London",
"postalCode" : "SW1W 9TQ",
"countryCode" : "GB",
"addressType" : "COMPANY"
}{
"urn" : "a9bc29a5-bf58-4c53-90e4-4c6252aaa663",
"identity" : {
"urn" : "249456c5-c884-4ef6-96b0-30e96a73897a",
"url" : "/n/v1/identity/249456c5-c884-4ef6-96b0-30e96a73897a"
},
"url" : "/n/v1/address/a9bc29a5-bf58-4c53-90e4-4c6252aaa663",
"officeBoxNumber" : "Google UK Ltd",
"street" : "71 Buckingham Palace Road",
"area" : "Belgravia",
"locality" : "London",
"postalCode" : "SW1W 9TQ",
"countryCode" : "GB",
"addressType" : "COMPANY"
}| Name | Type | Description | Constraints |
|---|---|---|---|
| urn | String representation of a Unique Resource Name. Typically a UUID with 36 characters. | The URN for the address | |
| identity | identity | The URN of the associated identity | |
| url | URL represented as a string | The URL for accessing the address | |
| officeBoxNumber | String literal | The post office box or internal routing address portion of the address | Optional. |
| street | String literal | The street component of the address e.g. '71 Buckingham Palace Road' | Required on create. |
| area | String literal | Area within a locality or city e.g. a region or town region e.g. 'Belgravia' | Optional. |
| locality | String literal | Locality or city e.g. London | |
| region | String literal | Region / district or county | Optional. |
| postalCode | String literal | Postal code / zip code e.g. SW1W 9TQ | Required on create. |
| countryCode | ISO 3166-1 alpha-2 country code e.g. 'GB' for Great Britton | ISO 3166-1 alpha-2 country code for the address | |
| addressType | String literal | Address type used for selecting addresses | Optional. Allowed values:
|