Create a Batch of Addresses

Create a batch of addresses.

Required authorization scopes: public.batch:write, public.address:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Batch Addresses Create

defaults
object

Default settings for each address (can be override on the individual address)

addresses
array of objects
required
length between 1 and 1000
addresses*

Address

string
required
≤ 200

City or Suburb

string | null
≤ 27

The company or organization at the address

string
≤ 50

Email address used to reach the person in `contact_name"

string
required
≤ 22

The full name of a person at the address

string | null
required
≤ 20

Phone number used to reach the person in contact_name (may or may not be SMS-ready)

string
enum

Country Code in Alpha-2 format (ISO 3166-1)

string
required
≤ 35

First line of the street address

string | null
≤ 35

Second line of the street address

string | null
required

Postal code. Leave it null or 0 if the country does not have postal codes. Mandatory for these countries: AD, AF, AI, AL, AM, AQ, AR, AS, AT, AU, AX, AZ, BA, BB, BD, BE, BG, BL, BM, BN, BQ, BR, BT, BV, BY, CA, CC, CH, CL, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DK, DO, DZ, EC, EE, EG, EH, ES, ET, FI, FK, FM, FO, FR, GA, GB, GE, GF, GG, GI, GL, GP, GR, GS, GT, GU, GW, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JO, JP, KG, KH, KR, KW, KY, KZ, LA, LB, LI, LK, LR, LS, LT, LU, LV, MA, MC, MD, ME, MF, MG, MH, MK, MM, MN, MP, MQ, MT, MV, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NZ, OM, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, RE, RO, RS, RU, SD, SE, SG, SH, SI, SJ, SK, SM, SN, SS, SV, SX, SZ, TC, TD, TH, TJ, TM, TN, TR, TW, UA, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, WF, WS, YT, ZA, ZM.

string | null
≤ 36

Reference ID

string
required
≤ 200

State, Province, or other top-level administrative region. Mandatory for these countries: AU, CA, CN, ID, MX, MY, TH, US, VN. Use abbreviations for naming the state if possible (2 letters for the US/CA, 2 or 3 letters for AU). For countries using provinces, use the full province names.

boolean | null

Whether the company validates the address they want to create

boolean
Defaults to false

Override user's address with the address validation results

Responses

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json