Categories
/api/helpdesk/categories/{categoryId}/resourceId
Manages hierarchical HelpDesk ticket categories. Access requires either the general configuration permission or the HelpDesk template-definition permission.
POST creates a request-local category, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. DELETE and active=false perform a soft deactivation; inactive categories remain addressable.
Deactivation is intentionally non-cascading and fails while a mail account or active descendant references the category. Parent changes must not create cycles. If the category field is visible to end users, at least one active category must remain effectively visible.
GET /api/helpdesk/categories/{categoryId}/resourceId
Identifier of an active default resource, or zero for no automatic resource assignment.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
categoryId |
path | string |
yes | category identifier |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
integer (int32) |
Successful response. |
Example Request
# Request GET /api/helpdesk/categories/<categoryId>/resourceId HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json 0
PUT /api/helpdesk/categories/{categoryId}/resourceId
Identifier of an active default resource, or zero for no automatic resource assignment.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
categoryId |
path | string |
yes | category identifier |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
integer (int32) |
yes |
Identifier of an active default resource, or zero for no automatic resource assignment. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
integer (int32) |
Successful response. |
Example Request
# Request PUT /api/helpdesk/categories/<categoryId>/resourceId HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> Content-Type: application/json 0 # Response HTTP/1.1 200 OK Content-Type: application/json 0
Common Error Responses
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": []
}
Schemas
Request and response schemas used on this page.
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |