Create a comment
Creates a comment on a record. The comment body is rich text, and owner_id plus entity identify the record it is attached to. Returns the created comment row.
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
Query Parameters
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
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 POST "https://example.com/workspaces/string/comments" \ -H "clarify-version: 2026-11" \ -H "Content-Type: application/json" \ -d '{ "entity": "person", "owner_id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71", "message": [ { "id": "1", "type": "paragraph", "children": [], "content": [ { "type": "text", "text": "Followed up after the QBR — Jane wants pricing by Friday.", "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}List campaign recipients
Returns the people enrolled in a campaign as an offset-paginated JSON:API collection, each with their per-recipient engagement: whether they opened, clicked, replied, or unsubscribed, and when each last happened. Filter by engagement with `filter[event]` (for example `filter[event]=clicked` to build a retargeting audience), by delivery state with `filter[status]`, by why a failed run ended with `filter[exit_reason]`, or by name/email with `filter[q]`. Recipients are collapsed to one row per person, preferring their active run.
Delete a comment
Permanently deletes a comment. A comment can be deleted by its author, by an admin, or by the owner of the agent that posted it. Returns the deleted comment. This cannot be undone.