Update a weather threshold

Módulo Workforce

PATCH/weather-thresholds/{id}weatherThresholds.update

A weather action threshold of a project: one value per hazard and level, with its emergency plan source. 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 safety.emergency_code.write.
Alcances de OAuth: safety.
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

weatherThresholds.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the weather threshold.

Cuerpo de la solicitud: WeatherThresholdUpdate

weatherThresholds.update: WeatherThresholdUpdate
Campo	Tipo	Obligatorio	Descripción
threshold_value	number	No	Value that triggers the level.Restricciones: range 0 to 200
source_note	string	No	Where the value comes from.Restricciones: length 1 to 300

{
  "threshold_value": 30,
  "source_note": "Emergency plan 4.2"
}

Respuesta 200: WeatherThreshold

weatherThresholds.update: WeatherThreshold
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the weather threshold.
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í	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
project_id	string (uuid)	Sí	Identifier of the project.
hazard	"Wind" \| "Lightning" \| "Heat"	Sí	Hazard.
alert_level	"Monitor" \| "Restrict" \| "Evacuate"	Sí	Level.
threshold_value	number	Sí	Value that triggers the level.Restricciones: range 0 to 200
unit	"mph" \| "mi" \| "F"	Sí	Unit: mph for wind, mi for lightning distance, F for heat index.
comparison	"At or Above" \| "At or Below"	Sí	At or Above for wind and heat, At or Below for lightning.
source_note	string	Sí	Where the value comes from.Restricciones: length 1 to 300

{
  "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",
  "hazard": "Wind",
  "alert_level": "Monitor",
  "threshold_value": 30,
  "unit": "mph",
  "comparison": "At or Above",
  "source_note": "Emergency plan 4.2"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/weather-thresholds/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 '{"threshold_value":30,"source_note":"Emergency plan 4.2"}'

const { data, etag } = await xos.weatherThresholds.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "threshold_value": 30,
    "source_note": "Emergency plan 4.2"
  }, { ifMatch: etag });

response = xos.weather_thresholds.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"threshold_value": 30, "source_note": "Emergency plan 4.2"}, if_match=etag)

xos weather-thresholds update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"threshold_value":30,"source_note":"Emergency plan 4.2"}' --if-match auto