Close an incident

Módulo Safety

POST/incidents/{id}/closeincidents.close

Closes a contained incident with sign-off through app.close_incident; the caller is recorded as the person signing off. The reporter of a critical incident cannot sign off its closure (422). Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad safety.incident.close.
Alcances de OAuth: safety.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

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

Cuerpo de la solicitud: IncidentCloseRequest

incidents.close: IncidentCloseRequest
Campo	Tipo	Obligatorio	Descripción
note	string	Sí	Sign-off note.Restricciones: length 1 to 500

{
  "note": "Area inspected and safe."
}

Respuesta 200: Incident

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

Ejemplos de código

curl -X POST "$XOS_BASE_URL/incidents/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/close" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"note":"Area inspected and safe."}'

const { data } = await xos.incidents.close("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "note": "Area inspected and safe."
  });

response = xos.incidents.close("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"note": "Area inspected and safe."})

xos incidents close 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"note":"Area inspected and safe."}'