Skip to main content
POST
Add comment to task

Overview

Add a comment to a task. Comments can be used to discuss task details, provide updates, or ask questions. When a comment is added, relevant team members (watchers, assignee, reporter, and project managers) are automatically notified via email and push notifications.

Request Body

string
required
The comment text. Supports HTML formatting.Example: "This task is progressing well. I've completed the first phase."
integer
required
The ID of the task to add the comment to. Can also be provided as refrence_id.Example: 456
array
Array of user IDs to add as watchers to the task when commenting. These users will receive notifications about future updates.Example: [5, 7, 9]

Example Request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
comment
string
required

The comment text (supports HTML)

Example:

"This task is progressing well. I've completed the first phase."

task_id
integer<int64>

The ID of the task to add the comment to

Example:

456

refrence_id
integer<int64>

Alternative field for task_id

Example:

456

type
string

The type of comment

Example:

"update"

watchersIds
integer<int64>[]

Array of user IDs to add as watchers

Example:

Response

Comment added successfully