Sign in

v1

latestOpenAPI 3.0.42026-08-0465139162.1 KB
Addresses

Create address

Required permission: Account information, Edit.

post/public/v2/addresses

Request body

addressLinesstring[] required

The address lines for the address. Example: 1 Rocket Road

localitystring nullable

The town/locality of the address. Example: Hawthorne

administrativeAreastring nullable

The administrative area of the address. Example: California

administrativeAreaCodestring nullable

Deprecated field: value will be ignored. Administrative area code will be determined from latitude and longitude.

regionstring nullable

The region of the address. Example: United States

regionCodestring nullable

Deprecated field: value will be ignored. Region Code will be determined from latitude and longitude.

postalCodestring nullable

The postal code of the address. Example: 90250-6844

metadatastring nullable

Optional field that can be used to store information about the address for external purposes

formattedAddressstring required

A user readable address. Example: 1 Rocket Road, Hawthorne, CA 90250-6844, US

latitudenumber double required

The required latitude of the address. Example: 33.92

longitudenumber double required

The required longitude of the address. Example: -118.32

Response

Address created

informationstring[] nullable
isValidboolean