Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Addresses

Create an address

Creates an address for a given account.

post/addresses

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

typestring required

The address type.

nickNamestring

The nickname of the address.

addressLine1string required

The first line of the address.

addressLine2string

The second line of the address.

addressLine3string

The third line of the address.

addressContactstring

The name of the contact associated with the address.

citystring required

The city of the address.

postcodestring required

The postal or ZIP code of the address.

countrystring required

The country of the address.

Example request

{
  "type": "office",
  "nickName": "office",
  "addressLine1": "Great Building",
  "addressLine2": "Four Maple Street",
  "addressLine3": "Southwark",
  "addressContact": "Brian May",
  "city": "string",
  "postcode": "SE13UB",
  "country": "England"
}

Response

Created

idstring uuid required

The ID of the address.

typestring required

The address type.

nickNamestring nullable

The nickname of the address.

addressLine1string required

The first line of the address.

addressLine2string nullable

The second line of the address.

addressLine3string nullable

The third line of the address.

addressContactstring nullable

The name of the contact associated with the address.

citystring required

The city of the address.

postcodestring required

The postal or ZIP code of the address.

countrystring required

The country of the address.

countryCodestring nullable

ISO 3166-1 2 digit country code.

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "office",
  "nickName": "office",
  "addressLine1": "Great Building",
  "addressLine2": "Four Maple Street",
  "addressLine3": "Southwark",
  "addressContact": "Brian May",
  "city": "string",
  "postcode": "SE13UB",
  "country": "England",
  "countryCode": "GB"
}