How to Use the ClickUp Comments API

The ClickUp Comments API lets you programmatically read, create, update, and delete comments on tasks so you can automate feedback, sync external tools, and streamline collaboration.

This how-to article walks you through each available operation, the required endpoints, and the essential request details based strictly on the official documentation.

Getting Started with the ClickUp Comments API

Before you work with comments in ClickUp through the API, make sure you have:

• An active ClickUp workspace.
• A valid API token with access to the tasks you want to manage.
• The task_id value for the target task.

All comment endpoints follow REST conventions and use HTTPS. You must include your authorization token in the request headers whenever you interact with the ClickUp platform via the Comments API.

ClickUp Comment Endpoints Overview

The Comments API lets you perform four main actions on task comments:

• List comments for a task.
• Create a new comment.
• Update an existing comment.
• Delete a comment.

Each operation uses a specific HTTP method and endpoint path and expects certain parameters in the URL and request body.

How to List Task Comments in ClickUp

Use the list endpoint to retrieve existing comments on a task. This is useful when you need to display comments in another system or process them in scripts.

ClickUp Endpoint to List Comments

The endpoint to list task comments follows this pattern:

GET /api/v2/task/{task_id}/comment

Replace {task_id} with the ID of the task whose comments you want to fetch.

Required Headers

• Authorization: Your ClickUp API token.
• Content-Type: application/json when appropriate.

Typical Use Cases

• Building a dashboard that shows recent feedback on important tasks.
• Exporting ClickUp comments to an external archive or reporting system.
• Analyzing comment history for quality or compliance.

How to Create Comments with the ClickUp API

You can create new task comments to log updates, add instructions, or integrate external notifications into ClickUp.

ClickUp Endpoint to Create a Comment

Use the following endpoint to create a comment on a specific task:

POST /api/v2/task/{task_id}/comment

Again, replace {task_id} with the correct ID of the task.

Request Body Fields

The request body typically contains JSON fields such as:

• comment_text: The text content of the comment.
• assignee or user-related fields if you are assigning or mentioning users (as supported by the API).
• Other optional fields indicated in the official documentation for formatting or behavior.

Always verify the exact field names and data types in the official ClickUp developer docs at the Comments API reference.

Step-by-Step: Creating a Comment

1. Identify the task and copy its task_id.
2. Prepare your POST URL using the endpoint pattern.
3. Set the required headers including your API token.
4. Build the JSON body with the comment text and supported options.
5. Send the request and handle the JSON response, which returns details of the created comment.

How to Update Comments in ClickUp

When you need to correct information or clarify an existing message, use the update endpoint to modify a comment on a task in ClickUp.

ClickUp Endpoint to Update a Comment

The pattern to update a comment is typically:

PUT /api/v2/comment/{comment_id}

Replace {comment_id} with the ID of the comment you want to change. You can obtain this ID from the list or create responses.

Request Body for Updates

The JSON body usually includes fields such as:

• comment_text: The updated text for the comment.

Only the fields you send will be updated based on what the documentation supports.

Updating a Comment: Practical Steps

1. Use the list endpoint or prior responses to find the comment_id.
2. Construct the PUT URL with that comment ID.
3. Set your authorization header with your ClickUp token.
4. Send a JSON body that includes the new comment content.
5. Check the response to confirm that the comment text has changed.

How to Delete Comments from ClickUp Tasks

If a comment is no longer needed or was added by mistake, you can delete it through the Comments API.

ClickUp Endpoint to Delete a Comment

Use the delete endpoint pattern below:

DELETE /api/v2/comment/{comment_id}

Replace {comment_id} with the ID of the comment you want to remove.

Delete Operation Behavior

• The call removes the specified comment from the task.
• You should verify whether your ClickUp workspace permissions allow you to delete the chosen comment.
• Always log or confirm deletions in your integration to avoid losing important information unintentionally.

Best Practices for Using the ClickUp Comments API

Follow these recommendations to keep your integrations stable and secure when working with comments in ClickUp.

Security and Authentication

• Store your ClickUp API token securely and never hard-code it in public repositories.
• Use environment variables or secret managers for tokens.
• Limit tokens to the smallest scope necessary where applicable.

Error Handling and Validation

• Check HTTP status codes for every response.
• Log error messages returned by the Comments API for debugging.
• Validate input locally before sending requests to avoid unnecessary failures.

Rate Limits and Performance

• Review the general ClickUp API rate limits in the broader documentation.
• Cache comment data when possible instead of repeatedly fetching the same information.
• Batch your operations thoughtfully to avoid hitting limits and to keep your integration responsive.

Advanced Ideas for ClickUp Comment Integrations

Once you understand the core operations, you can build more advanced automations that rely on comments in ClickUp.

• Sync comments between ClickUp and help desk platforms to centralize customer communication.
• Automatically create comments when external events happen, such as CI pipeline failures.
• Generate summary comments that compile updates from multiple team tools.

If you need help designing a robust integration strategy around the ClickUp API, you can explore consulting services at Consultevo for additional guidance.

Where to Learn More About the ClickUp Comments API

This guide summarizes how to list, create, update, and delete comments on tasks using the official Comments API. For the full parameter list, example payloads, and the latest updates, always refer to the official ClickUp Comments documentation.

By following these steps and best practices, you can confidently integrate task comments into your workflows and unlock more value from your ClickUp workspace.

Need Help With ClickUp?

If you want expert help building, automating, or scaling your ClickUp workspace, work with ConsultEvo — trusted ClickUp Solution Partners.

Get Help

“`