Update a weather threshold
Workforce module
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.
- Requires the capability safety.emergency_code.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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the weather threshold. |
Request body: WeatherThresholdUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| threshold_value | number | No | Value that triggers the level.Constraints: range 0 to 200 |
| source_note | string | No | Where the value comes from.Constraints: length 1 to 300 |
{
"threshold_value": 30,
"source_note": "Emergency plan 4.2"
}Response 200: WeatherThreshold
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the weather threshold. |
| 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 | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| hazard | "Wind" | "Lightning" | "Heat" | Yes | Hazard. |
| alert_level | "Monitor" | "Restrict" | "Evacuate" | Yes | Level. |
| threshold_value | number | Yes | Value that triggers the level.Constraints: range 0 to 200 |
| unit | "mph" | "mi" | "F" | Yes | Unit: mph for wind, mi for lightning distance, F for heat index. |
| comparison | "At or Above" | "At or Below" | Yes | At or Above for wind and heat, At or Below for lightning. |
| source_note | string | Yes | Where the value comes from.Constraints: 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"
}Code samples
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