Address Object Fields

Use this entity to specify elements of an address or addresses.

FieldDetailsDescription
country_subdivision_code

Type: String

Max: 6

The address region or state code. Leave blank if not required.
city

Type: String

Max: 256

City.
postal_code

Type: String

Max: 256

Post code.
county

Type: String

Max: 256

County.
country_code

Min: 2

Max: 2

Pattern: ^[A-Z]{2}$

2 letter ISO country code.
street_name

Type: String

Max: 256

The street name. You can concatenate multiple lines with a comma (,).
address_detail

Type: String

Max: 512

Further address details like apartment number.
freeform_address

Type: String

Max: 256

Specify a free text address.

You can use this when a structured address is not available.
building_number

Type: String

Max: 256

The number of the building.