Comments
Update a comment
Replaces the body of an existing comment. Only the comment’s author may edit it. Returns the updated comment.
Authorization<token>
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
workspace*string
The workspace slug — the {slug} segment of your Clarify workspace URL.
id*string
The unique ID of the comment.
Query Parameters
silent?boolean
When true, suppresses in-app and Slack notifications for this mutation and batches its live updates, so open views can lag by up to 20 seconds.
Header Parameters
clarify-version?string
The API version for this request. Send 2026-11 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/workspaces/string/comments/string" \ -H "clarify-version: 2026-11" \ -H "Content-Type: application/json" \ -d '{ "message": [ { "id": "1", "type": "paragraph", "children": [], "content": [ { "type": "text", "text": "Followed up after the QBR — Jane signed off on pricing.", "styles": {} } ] } ] }'{ "_id": "9d3e1f7a-2c4b-4e6d-8a1f-5b7c9e0d2a46", "message": [ { "id": "1", "type": "paragraph", "children": [], "content": [ { "type": "text", "text": "Followed up after the QBR — Jane wants pricing by Friday.", "styles": {} } ] } ], "owner_id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71", "entity": "person", "_created_at": "2026-01-15T09:30:00.000Z", "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "_updated_at": null, "_updated_by": null}