Add an individual address

post

https://sandbox-api.prioritycommerce.com/v1/individuals/{individualId}/addresses

Adds an address to an individual.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

individualId

string

required

ID of the individual, for example ind_2b7e4f13-6c9a-4d51-8a3e-9d0f2c6b8e74.

Body Params

The address to add.

type

string

enum

required

What the address is used for. Businesses usually use registered, physical, mailing or headquarters; individuals usually use home, mailing or work.

Allowed:

externalId

string

length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

line1

string

required

Street address, such as the building number and street name.

line2

string

Additional address details, such as a suite, unit or floor.

city

string

required

City or town.

stateProvince

string

required

State or province, as a two-letter code where one exists, for example TX.

postalCode

string

required

ZIP or postal code.

countryCode

string

required

^[A-Z]{2}$

Country, as a two-letter ISO 3166-1 code, for example US.

isPrimary

boolean

Set to true for the main record of this kind.

Headers

idempotency-key

string

Optional. A unique value, such as a UUID, that identifies this request. If you retry with the same key, the change is not applied twice.

Responses

201Created. The response contains the new record.

401The API key is missing or invalid.

404No record exists with the ID in the path.

422The request failed validation. errors lists each field to fix.