CommonCounterpart addresses

Set a counterpart's default address

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

address_idstringRequired
counterpart_idstringRequired

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Response

Successful Response
idstringformat: "uuid"
Unique ID of the address in the system
citystring<=255 characters
City name.
counterpart_idstringformat: "uuid"
ID of the counterpart that owns the address.
countryenum

Two-letter ISO country code (ISO 3166-1 alpha-2).

is_defaultboolean
True if address is the default address of the counterpart.
line1string<=255 characters
Street address.
postal_codestring<=255 characters
ZIP or postal code.
line2string<=255 characters

Additional address information (if any).

statestring<=255 characters
State, region, province, or county.

Errors

401
Post Counterparts ID Addresses ID Make Default Request Unauthorized Error
403
Post Counterparts ID Addresses ID Make Default Request Forbidden Error
404
Post Counterparts ID Addresses ID Make Default Request Not Found Error
422
Post Counterparts ID Addresses ID Make Default Request Unprocessable Entity Error
500
Post Counterparts ID Addresses ID Make Default Request Internal Server Error