Skip to main content
POST
/
v1
/
cases
/
{case_token}
/
comments
Add comment to case
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "body": "<string>",
  "type": "Comment",
  "mentions": [
    "<string>"
  ]
}
'
{
  "data": {
    "token": "cmt_7r3s1t5u",
    "case_token": "<string>",
    "author": {
      "user_id": "<string>",
      "name": "<string>",
      "initials": "<string>"
    },
    "type": "Comment",
    "body": "<string>",
    "mentions": [
      "<string>"
    ],
    "reactions": [
      {
        "emoji": "<string>",
        "user_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Headers

Idempotency-Key
string<uuid>

Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.

Path Parameters

case_token
string
required

Case token.

Body

application/json

Request body for adding a comment to a case.

body
string
required

Comment content. Use @user_id syntax for mentions.

Maximum string length: 10000
type
enum<string>
default:Comment

Comment type. System type is reserved for auto-generated entries.

Available options:
Comment,
Decision,
Note
mentions
string[]

User IDs to mention (notifications are sent).

Response

Comment added.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

data
object

A discussion entry on a case. Comments support analyst notes, formal decisions, system events, and team mentions for collaboration.

meta
object