Update an inspection item

Safety module

PATCH/inspection-items/{id}inspectionItems.update

An item of an inspection template. 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.

Requires the capability safety.inspection_template.write.
OAuth scopes: safety.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

inspectionItems.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the inspection item.

Request body: InspectionItemUpdate

inspectionItems.update: InspectionItemUpdate
Field	Type	Required	Description
position	integer	No	Item order.Constraints: range 1 to any
prompt	string	No	What to check.Constraints: length 1 to 300
is_critical	boolean	No	Whether a failure of this item stops use.

{
  "position": 1,
  "prompt": "Guardrails secured on all stage edges",
  "is_critical": true
}

Response 200: InspectionItem

inspectionItems.update: InspectionItem
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the inspection item.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
inspection_template_id	string (uuid)	Yes	Identifier of the inspection template.
position	integer	Yes	Item order.Constraints: range 1 to any
prompt	string	Yes	What to check.Constraints: length 1 to 300
is_critical	boolean	Yes	Whether a failure of this item stops use.

{
  "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",
  "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "prompt": "Guardrails secured on all stage edges",
  "is_critical": true
}

Code samples

curl -X PATCH "$XOS_BASE_URL/inspection-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,"prompt":"Guardrails secured on all stage edges","is_critical":true}'

const { data, etag } = await xos.inspectionItems.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "position": 1,
    "prompt": "Guardrails secured on all stage edges",
    "is_critical": true
  }, { ifMatch: etag });

response = xos.inspection_items.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"position": 1, "prompt": "Guardrails secured on all stage edges", "is_critical": True}, if_match=etag)

xos inspection-items update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"position":1,"prompt":"Guardrails secured on all stage edges","is_critical":true}' --if-match auto