Clear a crisis alert
Módulo Safety
POST/crisis-alerts/{id}/clearcrisisAlerts.clear
Clears the alert and notifies the project. 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.dispatch.
- 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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the crisis alert. |
Respuesta 200: CrisisAlert
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the crisis alert. |
| 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. |
| message | string | Sí | Alert message.Restricciones: length 1 to 300 |
| issued_at | string (date-time) | Sí | When the alert was issued. |
| ended_at | string (date-time) | null | Sí | When the alert was cleared. |
| emergency_code | string | Sí | Canon emergency code announced.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"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",
"message": "Weather hold: clear the north lawn.",
"issued_at": "2026-10-08T14:30:00Z",
"ended_at": "2026-10-08T14:30:00Z",
"emergency_code": "CODE_RED"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/crisis-alerts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/clear" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.crisisAlerts.clear("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.crisis_alerts.clear("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos crisis-alerts clear 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f