Docs
Update Resource State
PUT /resource-states/{resourceStateId}
PUT
/resource-states/{resourceStateId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Updates a resource state's display fields and active flag. sortOrder is managed by the server and cannot be changed through this endpoint.
Setting isActive=false is the correct way to soft-deprecate a state that is still referenced by historical rule thresholds or state records. Deactivated states remain in the listing but signal to pickers that they should not be offered for new selections.
Requires EventSettings permission on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| resourceStateId | Guid | Required | The ID of the state to update. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Display name. Must not be empty. |
| category | string | Required | One of `Regular`, `Premium`, `Penalty`, `Violation`. |
| color | string? | Optional | Hex color or token. |
| isActive | bool | Required | `true` keeps the state in pickers; `false` soft-deprecates. |
Response
200 OK — No response body.
Error Codes
| Code | HTTP Status | Description |
|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid token. |
NOT_FOUND | 404 | Resource state not found on this event. |
BAD_REQUEST | 400 | Name empty or category invalid. |