Update an incident

Safety module

PATCH/incidents/{id}incidents.update

An incident with dispatch. A critical incident cannot be relabeled and closed in one statement; closing requires sign-off. 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.incident.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

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

Request body: IncidentUpdate

incidents.update: IncidentUpdate
Field	Type	Required	Description
title	string	No	Short description.Constraints: length 1 to 300
occurred_at	string (date-time)	No	When it happened.
zone_id	string (uuid) \| null	No	Identifier of the zone.
latitude	number \| null	No	WGS 84 latitude.Constraints: range -90 to 90
longitude	number \| null	No	WGS 84 longitude.Constraints: range -180 to 180
severity_enum_id	string	No	Severity: a row of the canon Incident Severity enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
accuracy_m	number \| null	No	Horizontal accuracy of the location in meters.
device_reported_at	string (date-time) \| null	No	When the reporter filed it on the device, for a report queued offline.

{
  "title": "Guest Fall Near North Bar",
  "occurred_at": "2026-10-08T14:30:00Z",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "latitude": 25.7617,
  "longitude": -80.1918,
  "severity_enum_id": "ENM-097",
  "accuracy_m": 8,
  "device_reported_at": "2026-10-08T14:30:00Z"
}

Response 200: Incident

incidents.update: Incident
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the incident.
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.
project_id	string (uuid)	Yes	Identifier of the project.
title	string	Yes	Short description.Constraints: length 1 to 300
occurred_at	string (date-time)	Yes	When it happened.
zone_id	string (uuid) \| null	Yes	Identifier of the zone.
latitude	number \| null	Yes	WGS 84 latitude.Constraints: range -90 to 90
longitude	number \| null	Yes	WGS 84 longitude.Constraints: range -180 to 180
severity_enum_id	string	Yes	Severity: a row of the canon Incident Severity enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
incident_number	integer	Yes	Number from the project's display key sequence.Constraints: range 1 to any
incident_state	"Reported" \| "Dispatched" \| "Contained" \| "Closed"	Yes	Incident state.
reported_by	string (uuid) \| null	Yes	Identifier of the reporter, from the session.
closed_signed_off_by	string (uuid) \| null	Yes	Identifier of the person who signed off the closure.
accuracy_m	number \| null	Yes	Horizontal accuracy of the location in meters.
device_reported_at	string (date-time) \| null	Yes	When the reporter filed it on the device, for a report queued offline.
closed_at	string (date-time) \| null	Yes	When the incident moved to Closed, from its transition ledger.

{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Guest Fall Near North Bar",
  "occurred_at": "2026-10-08T14:30:00Z",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "latitude": 25.7617,
  "longitude": -80.1918,
  "severity_enum_id": "ENM-097",
  "incident_number": 142,
  "incident_state": "Reported",
  "reported_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "closed_signed_off_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "accuracy_m": 8,
  "device_reported_at": "2026-10-08T14:30:00Z",
  "closed_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/incidents/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 '{"title":"Guest Fall Near North Bar","occurred_at":"2026-10-08T14:30:00Z","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","latitude":25.7617,"longitude":-80.1918,"severity_enum_id":"ENM-097","accuracy_m":8,"device_reported_at":"2026-10-08T14:30:00Z"}'

const { data, etag } = await xos.incidents.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "title": "Guest Fall Near North Bar",
    "occurred_at": "2026-10-08T14:30:00Z",
    "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "latitude": 25.7617,
    "longitude": -80.1918,
    "severity_enum_id": "ENM-097",
    "accuracy_m": 8,
    "device_reported_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });

response = xos.incidents.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"title": "Guest Fall Near North Bar", "occurred_at": "2026-10-08T14:30:00Z", "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "latitude": 25.7617, "longitude": -80.1918, "severity_enum_id": "ENM-097", "accuracy_m": 8, "device_reported_at": "2026-10-08T14:30:00Z"}, if_match=etag)

xos incidents update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"title":"Guest Fall Near North Bar","occurred_at":"2026-10-08T14:30:00Z","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","latitude":25.7617,"longitude":-80.1918,"severity_enum_id":"ENM-097","accuracy_m":8,"device_reported_at":"2026-10-08T14:30:00Z"}' --if-match auto