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.

Example: 5973c3bc-70f4-48d6-92d5-4007f484b76c
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json
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.

Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

patch/addresses/{addressId}
Request samples
application/json
{
  • "type": "office",
  • "nickName": "office",
  • "addressLine1": "Great Building",
  • "addressLine2": "Four Maple Street",
  • "addressLine3": "Southwark",
  • "addressContact": "Brian May",
  • "city": "London",
  • "postcode": "SE13UB",
  • "country": "England"
}
Response samples
application/json
{
  • "id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
  • "type": "office",
  • "nickName": "office",
  • "addressLine1": "Great Building",
  • "addressLine2": "Four Maple Street",
  • "addressLine3": "Southwark",
  • "addressContact": "Brian May",
  • "city": "London",
  • "postcode": "SE13UB",
  • "country": "England"
}