Clickup · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clickup Chat API

20 actions 20 updates phrasing extends openapi/clickup-chat-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Clickup's API. It is a proposal applied on top of the contract, not a document Clickup publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 20 · first 16 shown; the file carries all of them

$.info

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels'].get

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels'].post

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/location'].post

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/direct_message'].post

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}'].get

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}'].delete

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}'].patch

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/followers'].get

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/members'].get

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages'].get

$.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages'].post

$.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}'].delete

$.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}'].patch

$.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions'].get

$.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clickup Chat API
  version: 1.0.0
extends: openapi/clickup-chat-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 19
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the chat Channels in a Workspace
      effect: read
      questions:
      - What chat Channels exist in my ClickUp Workspace?
      - Can I list only the Channels I follow, or ones with messages since a certain time?
      - Are closed Channels included when I list Workspace Channels?
      instructions:
      - text: List the chat Channels in Workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Show Channels in Workspace {workspace_id} that have messages since {with_message_since}.
        slots:
          workspace_id: path.workspace_id
          with_message_since: query.with_message_since
      - text: Get up to {limit} Channels I follow in Workspace {workspace_id}.
        slots:
          limit: query.limit
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a standalone chat Channel
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a Channel named {name} in Workspace {workspace_id}.
        slots:
          name: requestBody.name
          workspace_id: path.workspace_id
      - text: Open a new {visibility} Channel called {name} with topic {topic} in Workspace {workspace_id}.
        slots:
          visibility: requestBody.visibility
          name: requestBody.name
          topic: requestBody.topic
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/location'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Channel on a Space, Folder or List
      effect: write
      questions:
      - Can I attach a chat Channel directly to a Space, Folder or List?
      - What is returned if the location already has a Channel?
      instructions:
      - text: Create a Channel on location {location} in Workspace {workspace_id}.
        slots:
          location: requestBody.location
          workspace_id: path.workspace_id
      - text: Add a chat Channel to the List or Folder at {location} in Workspace {workspace_id} with topic {topic}.
        slots:
          location: requestBody.location
          workspace_id: path.workspace_id
          topic: requestBody.topic
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/direct_message'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Direct Message with up to 15 users
      effect: write
      questions:
      - How many people can be in a Direct Message conversation?
      - Will starting a DM with the same users give me the existing conversation?
      instructions:
      - text: Start a Direct Message with users {user_ids} in Workspace {workspace_id}.
        slots:
          user_ids: requestBody.user_ids
          workspace_id: path.workspace_id
      - text: Open a DM between me and {user_ids} in Workspace {workspace_id}.
        slots:
          user_ids: requestBody.user_ids
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one chat Channel's details
      effect: read
      questions:
      - How do I look up a single chat Channel by its ID?
      - Can I get a Channel's description back as markdown?
      instructions:
      - text: Get Channel {channel_id} in Workspace {workspace_id}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
      - text: Show details of Channel {channel_id} in Workspace {workspace_id} with description format {description_format}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
          description_format: query.description_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chat Channel
      effect: destructive
      questions:
      - Can I delete a Channel that's tied to a Space, Folder or List?
      - What's the way to remove a chat Channel entirely?
      instructions:
      - text: Delete Channel {channel_id} in Workspace {workspace_id}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
      - text: Remove chat Channel {channel_id} from Workspace {workspace_id} permanently.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a chat Channel's settings
      effect: write
      questions:
      - 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?
      instructions:
      - text: Rename Channel {channel_id} in Workspace {workspace_id} to {name}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
          name: requestBody.name
      - text: Set the topic of Channel {channel_id} in Workspace {workspace_id} to {topic}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
          topic: requestBody.topic
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/followers'].get
  update:
    x-apievangelist-phrasing:
      intent: List the followers of a chat Channel
      effect: read
      questions:
      - Who is following a particular chat Channel?
      - Can I page through a Channel's followers with a cursor?
      instructions:
      - text: List followers of Channel {channel_id} in Workspace {workspace_id}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
      - text: Get the next {limit} followers of Channel {channel_id} in Workspace {workspace_id} after cursor {cursor}.
        slots:
          limit: query.limit
          channel_id: path.channel_id
          workspace_id: path.workspace_id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of a chat Channel
      effect: read
      questions:
      - Which people are members of a given chat Channel?
      - How do I page through the member list of a large Channel?
      instructions:
      - text: List members of Channel {channel_id} in Workspace {workspace_id}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
      - text: Get {limit} members of Channel {channel_id} in Workspace {workspace_id} starting at cursor {cursor}.
        slots:
          limit: query.limit
          channel_id: path.channel_id
          workspace_id: path.workspace_id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the messages in a chat Channel
      effect: read
      questions:
      - How can I read the recent messages posted in a chat Channel?
      - Can channel messages come back as markdown instead of rich text?
      instructions:
      - text: Get messages from Channel {channel_id} in Workspace {workspace_id}.
        slots:
          channel_id: path.channel_id
          workspace_id: path.workspace_id
      - text: Fetch the last {limit} messages in Channel {channel_id} of Workspace {workspace_id} as {content_format}.
        slots:
          limit: query.limit
          channel_id: path.channel_id
          workspace_id: path.workspace_id
          content_format: query.content_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to a chat Channel
      effect: write
      questions:
      - 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?
      - Is it possible to assign a chat message to someone when I send it?
      instructions:
      - text: Send {content} as a {type} message to Channel {channel_id} in Workspace {workspace_id}.
        slots:
          content: requestBody.content
          type: requestBody.type
          channel_id: path.channel_id
          workspace_id: path.workspace_id
      - text: Post {content} to Channel {channel_id} in Workspace {workspace_id} and assign it to {assignee}.
        slots:
          content: requestBody.content
          channel_id: path.channel_id
          workspace_id: path.workspace_id
          assignee: requestBody.assignee
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chat message
      effect: destructive
      questions:
      - Can I delete a message I posted in chat?
      - What do I need to remove a specific chat message?
      instructions:
      - text: Delete message {message_id} in Workspace {workspace_id}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
      - text: Remove chat message {message_id} from Workspace {workspace_id}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit or resolve a chat message
      effect: write
      questions:
      - How do I edit the text of a chat message after sending it?
      - Can I mark a chat message as resolved or reassign it?
      instructions:
      - text: Change the content of message {message_id} in Workspace {workspace_id} to {content}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
          content: requestBody.content
      - text: Mark message {message_id} in Workspace {workspace_id} as resolved.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the reactions on a chat message
      effect: read
      questions:
      - Which emoji reactions has a chat message received?
      - Can I see who reacted to a message?
      instructions:
      - text: List reactions on message {message_id} in Workspace {workspace_id}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
      - text: Show the first {limit} reactions to message {message_id} in Workspace {workspace_id}.
        slots:
          limit: query.limit
          message_id: path.message_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a chat message with an emoji
      effect: write
      questions:
      - 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?
      instructions:
      - text: React to message {message_id} in Workspace {workspace_id} with {reaction}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
          reaction: requestBody.reaction
      - text: Add a {reaction} emoji to chat message {message_id} in Workspace {workspace_id}.
        slots:
          reaction: requestBody.reaction
          message_id: path.message_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions/{reaction}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an emoji reaction from a message
      effect: destructive
      questions:
      - Can I take back an emoji reaction I left on a chat message?
      - What's needed to remove one specific reaction from a message?
      instructions:
      - text: Remove my {reaction} reaction from message {message_id} in Workspace {workspace_id}.
        slots:
          reaction: path.reaction
          message_id: path.message_id
          workspace_id: path.workspace_id
      - text: Delete reaction {reaction} on chat message {message_id} in Workspace {workspace_id}.
        slots:
          reaction: path.reaction
          message_id: path.message_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the replies to a chat message
      effect: read
      questions:
      - How do I read the thread of replies under a chat message?
      - Can message replies be paged with a cursor?
      instructions:
      - text: Get replies to message {message_id} in Workspace {workspace_id}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
      - text: Show the next {limit} replies in the thread under message {message_id} in Workspace {workspace_id} after cursor {cursor}.
        slots:
          limit: query.limit
          message_id: path.message_id
          workspace_id: path.workspace_id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to a chat message in its thread
      effect: write
      questions:
      - How can I post a threaded reply to a chat message?
      - Can I assign a reply message to a teammate?
      instructions:
      - text: Reply {content} to message {message_id} in Workspace {workspace_id} as type {type}.
        slots:
          content: requestBody.content
          message_id: path.message_id
          workspace_id: path.workspace_id
          type: requestBody.type
      - text: Post a thread reply {content} under message {message_id} in Workspace {workspace_id} and assign it to {assignee}.
        slots:
          content: requestBody.content
          message_id: path.message_id
          workspace_id: path.workspace_id
          assignee: requestBody.assignee
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/tagged_users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users tagged in a chat message
      effect: read
      questions:
      - Who was @mentioned in a particular chat message?
      - Can I list the tagged users on a message in pages?
      instructions:
      - text: List users tagged in message {message_id} in Workspace {workspace_id}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
      - text: Show who was mentioned in chat message {message_id} of Workspace {workspace_id}.
        slots:
          message_id: path.message_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/clickup-chat-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.