v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB

Addresses

Update an address

Updates an address, based on a given address ID. You can only update an address
if it's not a registered address.

patch/addresses/{addressId}

Path parameters

addressIdstring uuid required

The ID of the address to work with.

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

typestring

The address type.

nickNamestring nullable

The nickname of the address.

addressLine1string

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

The city of the address.

postcodestring

The postal or ZIP code of the address.

countrystring

The country of the address.

countryCodestring nullable

ISO 3166-1 2 digit country code.

Example request

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

Response

idstring uuid required

The ID of the address.

typestring required