Skip to main content
PATCH
/
v1
/
workflow-tags
/
{tag_id}
Update Tag
curl --request PATCH \
  --url https://api.cyberdesk.io/v1/workflow-tags/{tag_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "color": "<string>",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_archived": true
}
'
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "order": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "emoji": "<string>",
  "color": "<string>",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_archived": false,
  "workflow_count": 123,
  "group": {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "<string>",
    "order": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "emoji": "<string>",
    "color": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

​
tag_id
string<uuid>
required

Body

application/json

Schema for updating a workflow tag

​
name
string | null
Required string length: 1 - 100
​
description
string | null
Maximum string length: 500
​
emoji
string | null
Maximum string length: 10
​
color
string | null
Maximum string length: 20
​
group_id
string<uuid> | null

Optional group for mutual exclusivity

​
is_archived
boolean | null

Archive tag to prevent new assignments

Response

Successful Response

Workflow tag response schema

​
name
string
required
Required string length: 1 - 100
​
id
string<uuid>
required
​
organization_id
string
required
​
order
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
Maximum string length: 500
​
emoji
string | null
Maximum string length: 10
​
color
string | null
Maximum string length: 20
​
group_id
string<uuid> | null

Optional group for mutual exclusivity

​
is_archived
boolean
default:false
​
workflow_count
integer | null

Number of workflows with this tag (returned in list endpoint)

​
group
WorkflowTagGroupResponse · object

The group this tag belongs to