Skip to navigation
PlatformComments

API · Comments · Add a comment (or threaded reply) to a resource

View as Markdown

Add a comment to a commentable resource. Set object_pk to the resource UUID and content_type to the resource family (currently task). For threaded replies, set parent to the parent comment ID.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

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

Request

This endpoint expects an object.
object_pkstringRequired

UUID of the resource being commented on (the task ID for content_type=task, etc.).

content_typeenumRequired

Commentable resource type. Currently supports task; other types (e.g. document, project) will be added as the commentable surface grows.

Allowed values:
commentstringRequired
Comment text.
parentintegerOptional

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

Response

Comment created.