Create a counterpart address

POST
/counterparts/:counterpart_id/addresses

Path parameters

counterpart_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
citystringRequired
City name.
countryenumRequired

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

line1stringRequired
Street address.
postal_codestringRequired
ZIP or postal code.
line2stringOptional
Additional address information (if any).
statestringOptional
State, region, province, or county.

Response

This endpoint returns an object.
idstring
Unique ID of the address in the system
citystring
City name.
counterpart_idstring
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
Street address.
postal_codestring
ZIP or postal code.
line2stringOptional
Additional address information (if any).
statestringOptional
State, region, province, or county.

Errors