Client Addresses

Create Client Address

Creates a client address.

POST

/client-addresses

curl --request POST \
  --url https://api.operating.app/v1/client-addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address1": "<string>",
  "address2": "<string>",
  "archivedAt": "<string>",
  "city": "<string>",
  "clientId": "<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.

Body

address1stringrequired

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.

citystringrequired

The city of the address

clientIdstringrequired

countrystringrequired

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

namestringrequired

The official name of the address

postalCodestringrequired

The postal code of the address

statestring | null

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team