/api/helpdesk/user-classes/{userClassId}/supervisorIds

Manages HelpDesk user classes and their supervisors. Access requires either the general configuration permission or the HelpDesk template-definition permission.

POST creates a request-local user class, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. Supervisor assignments are persisted together with the class and are restored best-effort after a partial failure.

DELETE and active=false perform a soft deactivation. The configured default class and a class currently assigned to users cannot be deactivated.

Complete set of supervising HelpDesk user account identifiers. Each value must be an existing lowercase alphanumeric GUID string, for example "0123456789abcdefghijklmno". When supplied, this property replaces the complete supervisor set; an empty array removes all supervisors.

# Request
GET /api/helpdesk/user-classes/<userClassId>/supervisorIds HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

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

[
    "8j4942vmqpkl9uipunqipno2r"
]

Complete set of supervising HelpDesk user account identifiers. Each value must be an existing lowercase alphanumeric GUID string, for example "0123456789abcdefghijklmno". When supplied, this property replaces the complete supervisor set; an empty array removes all supervisors.

# Request
PUT /api/helpdesk/user-classes/<userClassId>/supervisorIds HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

[
    "e7hlamkvzzq2nmw6nw6yzzmo3"
]

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

[
    "3x2w2gv1pt1inadslxajzc528"
]

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.