Update a comment

Módulo Platform

PATCH/comments/{id}comments.update

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

comments.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the comment.

Cuerpo de la solicitud: CommentUpdate

comments.update: CommentUpdate
Campo	Tipo	Obligatorio	Descripción
body	string	No	Comment text; mentions are recorded separately.Restricciones: length 1 to 10000
source	"App" \| "Email" \| "API"	No	Where the comment came from.

{
  "body": "Load-in moved to 07:00.",
  "source": "App"
}

Respuesta 200: Comment

comments.update: 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 PATCH "$XOS_BASE_URL/comments/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 '{"body":"Load-in moved to 07:00.","source":"App"}'

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

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

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