Operations 19
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/v3/workspaces/{workspace_id}/chat/channels
List the chat Channels in a Workspace · Retrieve Channels
#
Ask an LLM
“What chat Channels exist in my ClickUp Workspace?”
“Can I list only the Channels I follow, or ones with messages since a certain time?”
Tell an agent
List the chat Channels in Workspace {workspace_id}.
Show Channels in Workspace {workspace_id} that have messages since {with_message_since}.
POST
/api/v3/workspaces/{workspace_id}/chat/channels
Create a standalone chat Channel · Create a Channel
#
Ask an LLM
“How do I start a new chat Channel that isn't attached to a Space, Folder or List?”
“What happens if I create a Channel with a name that already exists?”
Tell an agent
Create a Channel named {name} in Workspace {workspace_id}.
Open a new {visibility} Channel called {name} with topic {topic} in Workspace {workspace_id}.
POST
/api/v3/workspaces/{workspace_id}/chat/channels/location
Create a Channel on a Space, Folder or List · Create a Channel on a Space, Folder, or List
#
Ask an LLM
“Can I attach a chat Channel directly to a Space, Folder or List?”
“What is returned if the location already has a Channel?”
Tell an agent
Create a Channel on location {location} in Workspace {workspace_id}.
Add a chat Channel to the List or Folder at {location} in Workspace {workspace_id} with topic {topic}.
POST
/api/v3/workspaces/{workspace_id}/chat/channels/direct_message
Start a Direct Message with up to 15 users · Create a Direct Message
#
Ask an LLM
“How many people can be in a Direct Message conversation?”
“Will starting a DM with the same users give me the existing conversation?”
Tell an agent
Start a Direct Message with users {user_ids} in Workspace {workspace_id}.
Open a DM between me and {user_ids} in Workspace {workspace_id}.
GET
/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}
Get one chat Channel's details · Retrieve a Channel
#
Ask an LLM
“How do I look up a single chat Channel by its ID?”
“Can I get a Channel's description back as markdown?”
Tell an agent
Get Channel {channel_id} in Workspace {workspace_id}.
Show details of Channel {channel_id} in Workspace {workspace_id} with description format {description_format}.
PATCH
/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}
Update a chat Channel's settings · Update a Channel
#
Ask an LLM
“How do I rename a chat Channel or change its topic?”
“Can I change a Channel's visibility or move it to a different location?”
Tell an agent
Rename Channel {channel_id} in Workspace {workspace_id} to {name}.
Set the topic of Channel {channel_id} in Workspace {workspace_id} to {topic}.
DELETE
/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}
Delete a chat Channel · Delete a Channel
#
Ask an LLM
“Can I delete a Channel that's tied to a Space, Folder or List?”
“What's the way to remove a chat Channel entirely?”
Tell an agent destructive · confirm first
Delete Channel {channel_id} in Workspace {workspace_id}.
Remove chat Channel {channel_id} from Workspace {workspace_id} permanently.
GET
/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/followers
List the followers of a chat Channel · Retrieve Channel followers
#
Ask an LLM
“Who is following a particular chat Channel?”
“Can I page through a Channel's followers with a cursor?”
Tell an agent
List followers of Channel {channel_id} in Workspace {workspace_id}.
Get the next {limit} followers of Channel {channel_id} in Workspace {workspace_id} after cursor {cursor}.
GET
/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/members
List the members of a chat Channel · Retrieve Channel members
#
Ask an LLM
“Which people are members of a given chat Channel?”
“How do I page through the member list of a large Channel?”
Tell an agent
List members of Channel {channel_id} in Workspace {workspace_id}.
Get {limit} members of Channel {channel_id} in Workspace {workspace_id} starting at cursor {cursor}.
GET
/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages
Read the messages in a chat Channel · Retrieve Channel messages
#
Ask an LLM
“How can I read the recent messages posted in a chat Channel?”
“Can channel messages come back as markdown instead of rich text?”
Tell an agent
Get messages from Channel {channel_id} in Workspace {workspace_id}.
Fetch the last {limit} messages in Channel {channel_id} of Workspace {workspace_id} as {content_format}.
POST
/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages
Send a message to a chat Channel · Send a message
#
Ask an LLM
“How do I post a new top-level message into a chat Channel?”
“Can a Channel message be sent as a post, like an announcement or idea?”
Tell an agent
Send {content} as a {type} message to Channel {channel_id} in Workspace {workspace_id}.
Post {content} to Channel {channel_id} in Workspace {workspace_id} and assign it to {assignee}.
PATCH
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}
Edit or resolve a chat message · Update a message
#
Ask an LLM
“How do I edit the text of a chat message after sending it?”
“Can I mark a chat message as resolved or reassign it?”
Tell an agent
Change the content of message {message_id} in Workspace {workspace_id} to {content}.
Mark message {message_id} in Workspace {workspace_id} as resolved.
DELETE
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}
Delete a chat message · Delete a message
#
Ask an LLM
“Can I delete a message I posted in chat?”
“What do I need to remove a specific chat message?”
Tell an agent destructive · confirm first
Delete message {message_id} in Workspace {workspace_id}.
Remove chat message {message_id} from Workspace {workspace_id}.
GET
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions
List the reactions on a chat message · Retrieve message reactions
#
Ask an LLM
“Which emoji reactions has a chat message received?”
“Can I see who reacted to a message?”
Tell an agent
List reactions on message {message_id} in Workspace {workspace_id}.
Show the first {limit} reactions to message {message_id} in Workspace {workspace_id}.
POST
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions
React to a chat message with an emoji · Create a message reaction
#
Ask an LLM
“How do I add an emoji reaction to a chat message?”
“What format do emoji names need to be in when reacting to a message?”
Tell an agent
React to message {message_id} in Workspace {workspace_id} with {reaction}.
Add a {reaction} emoji to chat message {message_id} in Workspace {workspace_id}.
DELETE
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions/{reaction}
Remove an emoji reaction from a message · Delete a message reaction
#
Ask an LLM
“Can I take back an emoji reaction I left on a chat message?”
“What's needed to remove one specific reaction from a message?”
Tell an agent destructive · confirm first
Remove my {reaction} reaction from message {message_id} in Workspace {workspace_id}.
Delete reaction {reaction} on chat message {message_id} in Workspace {workspace_id}.
GET
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies
Read the replies to a chat message · Retrieve message replies
#
Ask an LLM
“How do I read the thread of replies under a chat message?”
“Can message replies be paged with a cursor?”
Tell an agent
Get replies to message {message_id} in Workspace {workspace_id}.
Show the next {limit} replies in the thread under message {message_id} in Workspace {workspace_id} after cursor {cursor}.
POST
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies
Reply to a chat message in its thread · Create a reply message
#
Ask an LLM
“How can I post a threaded reply to a chat message?”
“Can I assign a reply message to a teammate?”
Tell an agent
Reply {content} to message {message_id} in Workspace {workspace_id} as type {type}.
Post a thread reply {content} under message {message_id} in Workspace {workspace_id} and assign it to {assignee}.
GET
/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/tagged_users
List users tagged in a chat message · Retrieve message tagged users
#
Ask an LLM
“Who was @mentioned in a particular chat message?”
“Can I list the tagged users on a message in pages?”
Tell an agent
List users tagged in message {message_id} in Workspace {workspace_id}.
Show who was mentioned in chat message {message_id} of Workspace {workspace_id}.