Create an address
Last updated
Last updated
Content-Type
*
string
The content-type must always be set to application/json
.
Authorization
*
string
The API live
or test
key.
clientId
*
string
The ID of the client associated with this address.
type
string
The type of address. Valid values include:
1. main
2. alternative
3. other
propertyNumber
string
The property number of the client's address.
buildingName
string
The building name of the client's address.
line
*
string
The line of the client's address.
city
*
string
The city or town of the client's address.
state
string
The county, state, or province of the client's address. When country is US
, this must be the state's USPS abbreviation (e.g. NY
, CA
, or DE
).
postalCode
string
The zip or postcode of the client's address.
country
*
string
The country of the client's address. This will be the two-letter country ISO code.
fromDate
string
The date the client moved into this address. The format is YYYY-MM-DD
.
toDate
string
The date the client moved out of this address. The format is YYYY-MM-DD
.