Create comments

POST/api/v1/comments

Create a new comment in a specified room, optionally mentioning one or more users.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Body Paramsapplication/json

textstringrequired
mentionsarray[object]required
Child attributes
- indexintegerrequired
- userIdstringrequired
contactIdstring<uuid>required

Responses

201

Created

requestIdstringrequired
dataobjectrequired
Child attributes
- idstringrequired
- roomIdstringrequired
- textstringrequired
- typestringrequired
- mentionsarray[object]required
  Child attributes
  userIdstringrequired
  namestringrequired
- senderobjectrequired
  Child attributes
  idstringrequired
  namestringrequired
- createdAtstringrequired

Request

curl -X POST "https://apigw.klinkcx.com/api/v1/comments" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Hey {0}, can you review this with {1} when you have a moment?",
  "mentions": [
    {
      "index": 0,
      "userId": "uuid-string"
    },
    {
      "index": 1,
      "userId": "uuid-string"
    }
  ],
  "contactId": "uuid-string"
}'

Response

{
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "data": {
    "id": "comment-uuid-002",
    "roomId": "room-uuid-abc",
    "text": "Hey @John Doe, can you review this with @Jane Smith?",
    "type": "comment",
    "mentions": [
      {
        "userId": "user-uuid-456",
        "name": "John Doe"
      },
      {
        "userId": "user-uuid-789",
        "name": "Jane Smith"
      }
    ],
    "sender": {
      "id": "user-uuid-123",
      "name": "Current Auth User"
    },
    "createdAt": "2026-02-27T12:20:00.000000Z"
  }
}