Saltar al contenido

Update a comment thread

Módulo Platform

PATCH/comment-threads/{id}commentThreads.update

A comment thread on any record. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad work.record.write.
  • Alcances de OAuth: work.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

commentThreads.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the comment thread.

Cuerpo de la solicitud: CommentThreadUpdate

commentThreads.update: CommentThreadUpdate
CampoTipoObligatorioDescripción
anchorstring | nullNoPart of the subject the thread is anchored to; null for the main thread.Restricciones: length 1 to 300
resolved_atstring (date-time) | nullNoWhen the thread was resolved; null while open.
{
  "anchor": "line:12",
  "resolved_at": "2026-10-08T14:30:00Z"
}

Respuesta 200: CommentThread

commentThreads.update: 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 PATCH "$XOS_BASE_URL/comment-threads/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"anchor":"line:12","resolved_at":"2026-10-08T14:30:00Z"}'
const { data, etag } = await xos.commentThreads.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "anchor": "line:12",
    "resolved_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });
response = xos.comment_threads.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"anchor": "line:12", "resolved_at": "2026-10-08T14:30:00Z"}, if_match=etag)
xos comment-threads update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"anchor":"line:12","resolved_at":"2026-10-08T14:30:00Z"}' --if-match auto