Saltar al contenido

Create a comment thread

Módulo Platform

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.

  • 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: CommentThreadCreate

commentThreads.create: CommentThreadCreate
CampoTipoObligatorioDescripción
subject_tablestringSíTable of the subject, one of app.comment_subjects.Restricciones: pattern ^[a-z][a-z0-9_]*$
subject_idstring (uuid)SíIdentifier of the row the thread is about.
anchorstring | nullNoPart of the subject the thread is anchored to; null for the main thread.Restricciones: length 1 to 300
{
  "subject_table": "records",
  "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "anchor": "line:12"
}

Respuesta 201: CommentThread

commentThreads.create: CommentThread
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the comment thread.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
subject_tablestringSíTable of the subject, one of app.comment_subjects.Restricciones: pattern ^[a-z][a-z0-9_]*$
subject_idstring (uuid)SíIdentifier of the row the thread is about.
anchorstring | nullSíPart of the subject the thread is anchored to; null for the main thread.Restricciones: length 1 to 300
resolved_atstring (date-time) | nullSíWhen the thread was resolved; null while open.
resolved_bystring (uuid) | nullSí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"
}

Ejemplos de código

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"}'