Update a comment
Platform module
PATCH/comments/{id}comments.update
A comment in a thread. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability work.record.write.
- OAuth scopes: work.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the comment. |
Request body: CommentUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| body | string | No | Comment text; mentions are recorded separately.Constraints: length 1 to 10000 |
| source | "App" | "Email" | "API" | No | Where the comment came from. |
{
"body": "Load-in moved to 07:00.",
"source": "App"
}Response 200: Comment
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the comment. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| comment_thread_id | string (uuid) | Yes | Identifier of the thread. |
| body | string | Yes | Comment text; mentions are recorded separately.Constraints: length 1 to 10000 |
| author_person_id | string (uuid) | Yes | Identifier of the author. |
| source | "App" | "Email" | "API" | Yes | Where the comment came from. |
| edited_at | string (date-time) | null | Yes | When the text was last edited. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"comment_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"body": "Load-in moved to 07:00.",
"author_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"source": "App",
"edited_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X PATCH "$XOS_BASE_URL/comments/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"body":"Load-in moved to 07:00.","source":"App"}'const { data, etag } = await xos.comments.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"body": "Load-in moved to 07:00.",
"source": "App"
}, { ifMatch: etag });response = xos.comments.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"body": "Load-in moved to 07:00.", "source": "App"}, if_match=etag)xos comments update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"body":"Load-in moved to 07:00.","source":"App"}' --if-match auto