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>"
  ]
}
'
import requests

url = "https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments"

payload = {
    "body": "<string>",
    "type": "Comment",
    "mentions": ["<string>"]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({body: JSON.stringify('<string>'), type: 'Comment', mentions: ['<string>']})
};

fetch('https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'body' => '<string>',
    'type' => 'Comment',
    'mentions' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments"

	payload := strings.NewReader("{\n  \"body\": \"<string>\",\n  \"type\": \"Comment\",\n  \"mentions\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"body\": \"<string>\",\n  \"type\": \"Comment\",\n  \"mentions\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"body\": \"<string>\",\n  \"type\": \"Comment\",\n  \"mentions\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "token": "cmt_7r3s1t5u",
    "case_token": "<string>",
    "author": {
      "user_id": "<string>",
      "name": "<string>",
      "initials": "<string>"
    },
    "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
    }
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}
{
  "error": {
    "message": "<string>",
    "request_id": "req_9k4m2n1p3q",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}

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