Client Addresses

Update Client Address

Updates the client address with the given id.

PATCH

/client-addresses/{id}

curl --request PATCH \
  --url https://api.operating.app/v1/client-addresses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address1": "<string>",
  "address2": "<string>",
  "archivedAt": "<string>",
  "city": "<string>",
  "country": "<string>",
  "description": "<string>",
  "externalAddresses": [
    {
      "externalId": "<string>",
      "name": "<string>"
    }
  ],
  "name": "<string>",
  "postalCode": "<string>",
  "state": "<string>"
}
'

{
  "data": {
    "address1": "<string>",
    "address2": "<string>",
    "archivedAt": "<string>",
    "city": "<string>",
    "clientId": "<string>",
    "country": "<string>",
    "createdAt": "<string>",
    "description": "<string>",
    "externalAddresses": [
      {
        "createdAt": "<string>",
        "externalId": "<string>",
        "externalSystemName": "<string>",
        "name": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "updatedAt": "<string>"
  },
  "meta": {}
}

Client addresses represent addresses for a client.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

The unique id of this record.

Body

address1string

The first line of the address

address2string | null

archivedAtstring | null

The instant this record was archived in ISO8601 format in UTC. Null if this record is not archived.

citystring

The city of the address

countrystring

The country of the address

descriptionstring | null

externalAddressesobject[]

External addresses associated with this client address. Their external ids must be unique across all addresses.

Show child attributes

namestring

The official name of the address

postalCodestring

The postal code of the address

statestring | null

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team