/api/helpdesk/statuses/{statusId}/active

Manages HelpDesk ticket statuses. Reading and writing requires the general configuration permission.

POST creates a request-local status, applies the supplied writable properties, validates it, and persists it. PUT and PATCH use the same validation before persisting changes. DELETE and active=false perform a soft deactivation; inactive statuses remain addressable and can be included in collection results.

Internal statuses cannot be renamed or deactivated. A status referenced by an active action cannot be deactivated. Deactivation also clears the configured read-follow-up status when it points to this status.

Whether this status is active. Setting this to false soft-deactivates the status and is subject to the same conflicts as DELETE. Setting it to true reactivates it.

# Request
GET /api/helpdesk/statuses/<statusId>/active HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

# Response
HTTP/1.1 200 OK
Content-Type: application/json

true

Whether this status is active. Setting this to false soft-deactivates the status and is subject to the same conflicts as DELETE. Setting it to true reactivates it.

# Request
PUT /api/helpdesk/statuses/<statusId>/active HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

true

# Response
HTTP/1.1 200 OK
Content-Type: application/json

true

The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:

{
    "status": 404,
    "code": "route_not_found",
    "message": "The requested API route does not exist.",
    "details": []
}

Request and response schemas used on this page.