Create Comment

POST 
/projects/tasks/:taskId/comments

Creates a top-level comment or a one-level reply (parentCommentId). Field is TipTap body — see TipTap documentation. Sanitised to a published allowlist before storage. Response: { "comment": { … } }.

Request

Version stringrequired

API Version

Available optionsv3

taskId stringrequired

Task id

locationId string

Location id. Required for channel: APP. Ignored for OAuth/PIT — those use the location on the auth token. Do not send in path, body, or headers.

application/json

application/json

Body

Bodyrequired

bodystringrequired

Comment text as TipTap HTML or TipTap JSON string. See TipTap documentation. Sanitised server-side to a published HTML allowlist (basic formatting + links). Max 32,000 characters.

Possible values: <= 32000 characters

parentCommentIdstringnullable

Parent comment ID for threaded replies. Omit for top-level comments.

mentionedUserIdsstring[]

User IDs mentioned in the comment

Example (auto)

{
  "body": "<p>Looks good — shipping next.</p>",
  "parentCommentId": "6a102435124ecfb348bd5510",
  "mentionedUserIds": [
    "user_2"
  ]
}

application/json

Successful response

application/json

Schema

Schema

commentobjectrequired

Comment

Example (auto)

{
  "comment": null
}