Create a new comment

Create a comment on an entity with optional file attachments

POST /v1/comments

Try it

Create a new comment

cURL

curl --request POST \
  --url http://localhost:3333/v1/comments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": "This task needs to be completed by end of week",
  "entityId": "tsk_abc123def456",
  "entityType": "task",
  "attachments": [
    {
      "fileName": "document.pdf",
      "fileType": "application/pdf",
      "fileData": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==",
      "description": "Meeting notes from Q4 planning session"
    }
  ]
}
'

201

{
  "id": "cmt_abc123def456",
  "content": "This task needs to be completed by end of week",
  "author": {
    "id": "usr_abc123def456",
    "name": "John Doe",
    "email": "[e-mail]",
    "image": "https://example.com/avatar.jpg",
    "deactivated": false
  },
  "attachments": [
    {
      "id": "att_abc123def456",
      "name": "document.pdf",
      "type": "application/pdf",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Headers

X-Organization-Id · string

Organization ID (required for session auth, optional for API key auth)

Body

application/json

content · string · required

Content of the comment

Maximum string length: 2000

Example:

"This task needs to be completed by end of week"

entityId · string · required

ID of the entity to comment on

Example:

"tsk_abc123def456"

entityType · enum<string> · required

Type of entity being commented on

Available options: task, vendor, risk, policy

Example:

"task"

attachments · object[]

Optional attachments to include with the comment

Show child attributes

attachments. fileName · string · required

Name of the file

Maximum string length: 255

Example:

"document.pdf"

attachments. fileType · string · required

MIME type of the file

Example:

"application/pdf"

attachments. fileData · string · required

Base64 encoded file data

Example:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=="

attachments. description · string

Description of the attachment

Maximum string length: 500

Example:

"Meeting notes from Q4 planning session"

Response

201 - application/json

Comment created successfully

id · string · required

Unique identifier for the comment

Example:

"cmt_abc123def456"

content · string · required

Comment content

Example:

"This task needs to be completed by end of week"

author · object · required

Comment author information

Show child attributes

author. id · string · required

User ID

Example:

"usr_abc123def456"

author. name · string · required

User name

Example:

"John Doe"

author. email · string · required

User email

Example:

"[e-mail]"

author. image · object · required

User profile image URL

Example:

"https://example.com/avatar.jpg"

author. deactivated · boolean | null · required

Whether the user is deactivated

Example:

false

attachments · object[] · required

Attachment metadata (URLs generated on-demand)

Show child attributes

attachments. id · string · required

Unique identifier for the attachment

Example:

"att_abc123def456"

attachments. name · string · required

Original filename

Example:

"document.pdf"

attachments. type · string · required

File type/MIME type

Example:

"application/pdf"

attachments. createdAt · string<date-time> · required

Upload timestamp

Example:

"2024-01-15T10:30:00Z"

createdAt · string<date-time> · required

Comment creation timestamp

Example:

"2024-01-15T10:30:00Z"