Create a comment thread
Platform module
POST/comment-threadscommentThreads.create
A comment thread on any record. Creates a comment thread. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability work.record.write.
- OAuth scopes: work.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: CommentThreadCreate
| Field | Type | Required | Description |
|---|---|---|---|
| subject_table | string | Yes | Table of the subject, one of app.comment_subjects.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| subject_id | string (uuid) | Yes | Identifier of the row the thread is about. |
| anchor | string | null | No | Part of the subject the thread is anchored to; null for the main thread.Constraints: length 1 to 300 |
{
"subject_table": "records",
"subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"anchor": "line:12"
}Response 201: CommentThread
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the comment thread. |
| 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. |
| subject_table | string | Yes | Table of the subject, one of app.comment_subjects.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| subject_id | string (uuid) | Yes | Identifier of the row the thread is about. |
| anchor | string | null | Yes | Part of the subject the thread is anchored to; null for the main thread.Constraints: length 1 to 300 |
| resolved_at | string (date-time) | null | Yes | When the thread was resolved; null while open. |
| resolved_by | string (uuid) | null | Yes | Identifier of the person who resolved it, set from the session. |
{
"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",
"subject_table": "records",
"subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"anchor": "line:12",
"resolved_at": "2026-10-08T14:30:00Z",
"resolved_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/comment-threads" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"subject_table":"records","subject_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","anchor":"line:12"}'const { data } = await xos.commentThreads.create({
"subject_table": "records",
"subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"anchor": "line:12"
});response = xos.comment_threads.create({"subject_table": "records", "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "anchor": "line:12"})xos comment-threads create --data '{"subject_table":"records","subject_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","anchor":"line:12"}'