×

Create List Comments in ClickUp

/ ClickUp / By

Create List Comments in ClickUp via API

This guide explains how to use the ClickUp REST API to create comments on a List, including required headers, URL parameters, and a complete request example.

Understanding the ClickUp List Comment Endpoint

The ClickUp API provides a dedicated endpoint for adding comments directly to a List. This is useful when you want to automate discussions, status notes, or system messages without manually typing them in the workspace.

The endpoint for creating a List comment is:

POST https://api.clickup.com/api/v2/list/{list_id}/comment

In this path, {list_id} is the identifier of the List where the new comment will be created.

Prerequisites for Using the ClickUp API

Before you call the endpoint, make sure you have:

  • An active workspace in ClickUp.
  • A valid API token with access to the target List.
  • The ID of the List where you want to create the comment.

The API token is used in the request header to authenticate your call to the ClickUp platform.

Required Headers for ClickUp List Comments

Every request to the List comment endpoint must include specific headers. For this ClickUp operation, set:

  • Authorization: Your personal API token.
  • Content-Type: application/json.

Example headers:

Authorization: <your_clickup_api_token>
Content-Type: application/json

URL Path Parameter in the ClickUp Request

The List ID is a required path parameter. Replace {list_id} with the actual numeric or alphanumeric ID from your ClickUp workspace.

Example endpoint with a placeholder value:

POST https://api.clickup.com/api/v2/list/12345/comment

You can obtain the List ID from the URL in the browser or by using other endpoints from the ClickUp API that list spaces, folders, and lists.

Request Body for Creating a ClickUp List Comment

The request body must be valid JSON. The exact fields and options are defined on the official API reference page at the ClickUp List comment endpoint documentation.

A typical request body includes:

  • comment_text: The actual content of the comment.
  • assignee or other optional fields depending on the detailed reference.

Structure your JSON to match the schema described in the ClickUp documentation so the API accepts and processes the request correctly.

Step-by-Step: Create a List Comment with the ClickUp API

Use the following steps to send a request that adds a new comment to a List in ClickUp.

Step 1: Collect ClickUp List and Token Details

Gather the following information:

  1. Your ClickUp API token.
  2. The List ID where the comment will be written.
  3. The text you want to store as a comment.

Keep the token secure and never expose it publicly.

Step 2: Build the ClickUp Request URL

Insert your List ID into the endpoint template:

https://api.clickup.com/api/v2/list/{list_id}/comment

Example:

https://api.clickup.com/api/v2/list/987654/comment

Step 3: Define Headers for the ClickUp API Call

Set up your HTTP client to send the correct headers:

{
  "Authorization": "<your_clickup_api_token>",
  "Content-Type": "application/json"
}

Without a valid Authorization header, ClickUp will reject the request.

Step 4: Compose the JSON Body

Prepare a JSON object that matches the structure described in the official reference. For a basic example, you might send:

{
  "comment_text": "This is a new list level comment created via API."
}

Adjust the fields according to the full ClickUp schema on the API reference page.

Step 5: Send the POST Request to ClickUp

Use your preferred tool or library:

  • Command line with curl.
  • REST client such as Postman or Insomnia.
  • Code using fetch, axios, or another HTTP library.

Example using curl (conceptual structure only):

curl -X POST 
  -H "Authorization: <your_clickup_api_token>" 
  -H "Content-Type: application/json" 
  -d '{
    "comment_text": "This is a new list comment via API."
  }' 
  https://api.clickup.com/api/v2/list/987654/comment

Handling ClickUp API Responses

After the request, the ClickUp API returns a JSON response. It includes:

  • Information about the new comment.
  • IDs and metadata that you can store for future operations.

If the request fails, you will receive an error code and message. Check that:

  • The token is valid and active.
  • The List ID exists and belongs to your workspace.
  • The request body matches the required format described in the ClickUp documentation.

Best Practices for Working with the ClickUp API

To keep your integration reliable and secure, follow these guidelines:

  • Store the ClickUp API token in environment variables or a secure vault.
  • Log responses for debugging, but never log sensitive credentials.
  • Validate input before sending it to the API to avoid malformed requests.
  • Use retry logic if your integration depends heavily on automated comments.

Using ClickUp Comments in Larger Workflows

List comments created through the API can be combined with other features to build complete workflows. For example:

  • Post a comment every time a deployment pipeline runs.
  • Add a summary comment when an external ticket is updated.
  • Notify team members about bulk data changes using automated comments.

These patterns help centralize context inside ClickUp so team members see key updates in one place.

ClickUp Automation and External Integrations

Because the API uses standard HTTP methods, you can trigger List comment creation from many systems, including custom webhooks, no-code tools, or backend services.

To plan broader automation strategies that combine comments with tasks, statuses, and reporting, you can explore expert resources like Consultevo, which focuses on implementation and workflow optimization.

Where to Find Full ClickUp API Details

This article summarizes how to create List comments, but the full specification, including every field and advanced option, is maintained on the official site. Always refer to the latest reference at ClickUp Create List Comment API for authoritative details.

By following the steps above and checking the official documentation regularly, you can confidently add automated List comments to your workspace and enhance your overall usage of ClickUp.

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

“`

Verified by MonsterInsights