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
}
}
}Add a comment to a case. Comments support @mentions for notifying team
members. Use type: Decision for formal compliance decisions that appear
in the audit trail.
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
}
}
}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.
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.
Case token.
Request body for adding a comment to a case.
Comment added.