Client Tags

Create Client Tag

Creates a client tag.

POST

/client-tags

Create Client Tag

curl --request POST \
  --url https://api.operating.app/v1/client-tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archivedAt": "<string>",
  "categoryId": "<string>",
  "description": "<string>",
  "externalClientTags": [
    {
      "externalId": "<string>",
      "name": "<string>"
    }
  ],
  "name": "<string>",
  "parentTagId": "<string>"
}
'

{
  "data": {
    "archivedAt": "<string>",
    "categoryId": "<string>",
    "createdAt": "<string>",
    "description": "<string>",
    "externalClientTags": [
      {
        "createdAt": "<string>",
        "externalId": "<string>",
        "externalSystemName": "<string>",
        "name": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "parentTagId": "<string>",
    "updatedAt": "<string>"
  },
  "meta": {}
}

Client tags can be used to categorize clients.

Authorizations

Authorizationstringheaderrequired

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

Body

archivedAtstring | null

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

categoryIdstring | null

The id of the category this tag is in.

descriptionstring | null

Freeform description of this tag.

Maximum string length: 5000

externalClientTagsobject[]

External client tags associated with this client tag. Their external ids must be unique across all client tags.

Show child attributes

namestringrequired

The name of this tag.

Required string length: 1 - 5000

parentTagIdstring | null

The id of the parent tag of this tag. Null if this tag has no parent tag.

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team