Create a weather alert role
Workforce module
POST/weather-alert-rolesweatherAlertRoles.create
A canon role the emergency plan names for a weather level; people assigned it on the project are alerted. Creates a weather alert role. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability safety.emergency_code.write.
- OAuth scopes: safety.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: WeatherAlertRoleCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| alert_level | "Monitor" | "Restrict" | "Evacuate" | Yes | Level. |
| role_code | string | Yes | Canon role notified.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"alert_level": "Monitor",
"role_code": "5000.01.01"
}Response 201: WeatherAlertRole
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the weather alert role. |
| 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. |
| alert_level | "Monitor" | "Restrict" | "Evacuate" | Yes | Level. |
| role_code | string | Yes | Canon role notified.Constraints: 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",
"alert_level": "Monitor",
"role_code": "5000.01.01"
}Code samples
curl -X POST "$XOS_BASE_URL/weather-alert-roles" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","alert_level":"Monitor","role_code":"5000.01.01"}'const { data } = await xos.weatherAlertRoles.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"alert_level": "Monitor",
"role_code": "5000.01.01"
});response = xos.weather_alert_roles.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "alert_level": "Monitor", "role_code": "5000.01.01"})xos weather-alert-roles create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","alert_level":"Monitor","role_code":"5000.01.01"}'