Create a comment

Platform module

POST/commentscomments.create

A comment in a thread. Creates a comment. 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: CommentCreate

comments.create: CommentCreate
Field	Type	Required	Description
comment_thread_id	string (uuid)	Yes	Identifier of the thread.
body	string	Yes	Comment text; mentions are recorded separately.Constraints: length 1 to 10000
source	"App" \| "Email" \| "API"	No	Where the comment came from.

{
  "comment_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "body": "Load-in moved to 07:00.",
  "source": "App"
}

Response 201: Comment

comments.create: 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 POST "$XOS_BASE_URL/comments" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"comment_thread_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","body":"Load-in moved to 07:00.","source":"App"}'

const { data } = await xos.comments.create({
    "comment_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "body": "Load-in moved to 07:00.",
    "source": "App"
  });

response = xos.comments.create({"comment_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "body": "Load-in moved to 07:00.", "source": "App"})

xos comments create --data '{"comment_thread_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","body":"Load-in moved to 07:00.","source":"App"}'