Authorizations
API key for authentication
Headers
Organization ID (required for session auth, optional for API key auth)
Body
application/json
Content of the comment
Maximum length:
2000
Example:
"This task needs to be completed by end of week"
ID of the entity to comment on
Example:
"tsk_abc123def456"
Type of entity being commented on
Available options:
task
, vendor
, risk
, policy
Example:
"task"
Optional attachments to include with the comment
Response
201 - application/json
Comment created successfully
Unique identifier for the comment
Example:
"cmt_abc123def456"
Comment content
Example:
"This task needs to be completed by end of week"
Comment author information
Attachment metadata (URLs generated on-demand)
Comment creation timestamp
Example:
"2024-01-15T10:30:00Z"