Update a record checklist item

Módulo Work

PATCH/record-checklist-items/{id}recordChecklistItems.update

One checklist item of a record. Items are rows, never array positions. 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.punch_list.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

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

Cuerpo de la solicitud: RecordChecklistItemUpdate

recordChecklistItems.update: RecordChecklistItemUpdate
Campo	Tipo	Obligatorio	Descripción
position	integer	No	Display position.Restricciones: range 1 to any
label	string	No	Item label.Restricciones: length 1 to 300
done	boolean	No	Whether the item is done.
evidence_document_id	string (uuid) \| null	No	Identifier of the photo or document evidence.

{
  "position": 1,
  "label": "Check the safety cables",
  "done": false,
  "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 200: RecordChecklistItem

recordChecklistItems.update: RecordChecklistItem
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the record checklist item.
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.
record_id	string (uuid)	Sí	Identifier of the record.
position	integer	Sí	Display position.Restricciones: range 1 to any
label	string	Sí	Item label.Restricciones: length 1 to 300
done	boolean	Sí	Whether the item is done.
done_by	string (uuid) \| null	Sí	Identifier of the person who ticked the item.
done_at	string (date-time) \| null	Sí	When the item was ticked.
evidence_document_id	string (uuid) \| null	Sí	Identifier of the photo or document evidence.

{
  "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",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "label": "Check the safety cables",
  "done": false,
  "done_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "done_at": "2026-10-08T14:30:00Z",
  "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/record-checklist-items/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 '{"position":1,"label":"Check the safety cables","done":false,"evidence_document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data, etag } = await xos.recordChecklistItems.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "position": 1,
    "label": "Check the safety cables",
    "done": false,
    "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });

response = xos.record_checklist_items.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"position": 1, "label": "Check the safety cables", "done": False, "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)

xos record-checklist-items update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"position":1,"label":"Check the safety cables","done":false,"evidence_document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto