Comment on a subject

Módulo Platform

POST/comments/on-subjectcomments.postOnSubject

Posts a comment on any row of app.comment_subjects by its table and id, as the caller, in the subject's main thread or the thread of an anchor, opening the thread on first use (`app.post_comment`). The subject's own read policy decides (404 when it is not visible). The add_comment action of automations calls it as the automation's owner. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad work.record.write.
Alcances de OAuth: work.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: SubjectCommentRequest

comments.postOnSubject: SubjectCommentRequest
Campo	Tipo	Obligatorio	Descripción
subject_table	string	Sí	Table of the subject, one of app.comment_subjects without its schema.Restricciones: pattern ^[a-z][a-z0-9_]*$
subject_id	string (uuid)	Sí	Identifier of the row commented on.
body	string	Sí	Comment text.Restricciones: length 1 to 20000
anchor	string	No	Part of the subject the thread is anchored to; absent for the main thread.Restricciones: length 1 to 300

{
  "subject_table": "records",
  "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "body": "Picked up, thanks.",
  "anchor": "line:12"
}

Respuesta 201: Comment

comments.postOnSubject: Comment
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the comment.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
comment_thread_id	string (uuid)	Sí	Identifier of the thread.
body	string	Sí	Comment text; mentions are recorded separately.Restricciones: length 1 to 10000
author_person_id	string (uuid)	Sí	Identifier of the author.
source	"App" \| "Email" \| "API"	Sí	Where the comment came from.
edited_at	string (date-time) \| null	Sí	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"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/comments/on-subject" \
  -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","body":"Picked up, thanks.","anchor":"line:12"}'

const { data } = await xos.comments.postOnSubject({
    "subject_table": "records",
    "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "body": "Picked up, thanks.",
    "anchor": "line:12"
  });

response = xos.comments.post_on_subject({"subject_table": "records", "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "body": "Picked up, thanks.", "anchor": "line:12"})

xos comments post-on-subject --data '{"subject_table":"records","subject_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","body":"Picked up, thanks.","anchor":"line:12"}'