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
}
'
import requests

url = "https://api.cyberdesk.io/v1/workflow-tags/{tag_id}"

payload = {
"name": "<string>",
"description": "<string>",
"emoji": "<string>",
"color": "<string>",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_archived": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
emoji: '<string>',
color: '<string>',
group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
is_archived: true
})
};

fetch('https://api.cyberdesk.io/v1/workflow-tags/{tag_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cyberdesk.io/v1/workflow-tags/{tag_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'emoji' => '<string>',
'color' => '<string>',
'group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'is_archived' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.cyberdesk.io/v1/workflow-tags/{tag_id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_archived\": true\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.cyberdesk.io/v1/workflow-tags/{tag_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_archived\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cyberdesk.io/v1/workflow-tags/{tag_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_archived\": true\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

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 | null

The group this tag belongs to