Description
Add a comment to a case.
Request
HTTP Method: POST
| Parameter | Description |
|---|---|
| value | The value of the comment to be added to the case. |
| author_email | Optional The email of the user commenting on the case. |
| Path Parameter | Description |
|---|---|
| case_id | ID of the case |
Sample request
curl -X POST \
https://<<META.tenant.domain>>/api/v1/cases/<<case_id>>/comment \
-H 'content-type: application/json' \
-H 'x-user-token: <api-token>' \
-d '{
"value": "This is a comment on a case"
}'
Response
A successful request will return a JSON object describing the updated case
Field description
| Parameter | Description |
|---|---|
| id | The ID of the record with the comment attached to the case. |
| action | The action taken on the case - commented in this instance. |
| value | The comment being added. |
| user | Details of the user who created the comment - id, first & last name, email & avatar url. |
Sample response
{
"id": 7508,
"action": "COMMENTED",
"value": "This is a comment",
"user": {
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@tines.io"
}
}