/api/helpdesk/actions

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

POST creates a request-local action, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. Internal or inactive actions cannot be changed.

Action deletion and deactivation require restart-sensitive cleanup and are intentionally not exposed by this API. Consequently "active" is read-only and no DELETE operation exists.

Lists configurable actions.

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

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

[
    {
        "id": 0,
        "name": "string",
        "statusId": 0,
        "internal": true,
        "billingType": 0
    }
]

Creates a custom action with a server-generated identifier. The request body must provide "name"; "statusId" must resolve to an active status. Numeric behavior properties, including an omitted "statusId", default to zero.

# Request
POST /api/helpdesk/actions HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    "name": "string",
    "statusId": 0,
    "billingType": 0,
    "lumpSumType": 0,
    "fixedCharge": 0.0
}

# Response
HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": 0,
    "name": "string",
    "statusId": 0,
    "internal": true,
    "billingType": 0
}

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.