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.
SecurityCommonAuth
Request
path Parameters
addressId
required
string <uuid>

The ID of the address to work with.

query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

type
string

The address type.

nickName
string or null <= 256 characters

The nickname of the address.

addressLine1
string [ 1 .. 256 ] characters

The first line of the address.

addressLine2
string or null <= 256 characters

The second line of the address.

addressLine3
string or null <= 256 characters

The third line of the address.

addressContact
string or null <= 256 characters

The name of the contact associated with the address.

city
string <= 256 characters

The city of the address.

postcode
string <= 50 characters

The postal or ZIP code of the address.

country
string <= 256 characters

The country of the address.

countryCode
string <= 2 characters

ISO 3166-1 2 digit country code.

Responses
200

OK

patch/addresses/{addressId}
Request samples
application/json
{
  • "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 samples
application/json
{
  • "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"
}