0

Update a Channel

by
Published Oct 17, 2025

This endpoint updates a single Channel.

Script clickup Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Clickup = {
3
  token: string;
4
};
5
/**
6
 * Update a Channel
7
 * This endpoint updates a single Channel.
8
 */
9
export async function main(
10
  auth: Clickup,
11
  workspace_id: string,
12
  channel_id: string,
13
  body: {
14
    content_format?: "text/md" | "text/plain";
15
    description?: string;
16
    location?: { id: string; type: "folder" | "list" | "space" };
17
    name?: string;
18
    topic?: string;
19
    visibility?: "PUBLIC" | "PRIVATE";
20
  },
21
) {
22
  const url = new URL(
23
    `https://api.clickup.com/api/v3/workspaces/${workspace_id}/chat/channels/${channel_id}`,
24
  );
25

26
  const response = await fetch(url, {
27
    method: "PATCH",
28
    headers: {
29
      "Content-Type": "application/json",
30
      Authorization: auth.token,
31
    },
32
    body: JSON.stringify(body),
33
  });
34
  if (!response.ok) {
35
    const text = await response.text();
36
    throw new Error(`${response.status} ${text}`);
37
  }
38
  return await response.json();
39
}
40