/api/helpdesk/forms/folders/{folderId}

Exposes HelpDesk form folders as a hierarchical WebAPI resource.

GET /api/helpdesk/forms/folders returns the protected root node with compact summaries of its direct forms and one shallow level of child summaries. Resolve a child folder for its direct contents; descendants are never embedded recursively. Individual folders support normal create, update, and delete operations. New folders default to FolderSharingMode#PRIVATE. A normal delete is deliberately limited to empty folders; recursive deletion is an explicit confirmation-protected tree action. Read-only identifiers are accepted and ignored when a GET representation is sent back unchanged.

Deletes this folder when it has no direct forms or child folders. Non-empty folders return a conflict and remain unchanged.

# Request
DELETE /api/helpdesk/forms/folders/<folderId> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

# Response
HTTP/1.1 204 No Content

Exposes HelpDesk form folders as a hierarchical WebAPI resource.

GET /api/helpdesk/forms/folders returns the protected root node with compact summaries of its direct forms and one shallow level of child summaries. Resolve a child folder for its direct contents; descendants are never embedded recursively. Individual folders support normal create, update, and delete operations. New folders default to FolderSharingMode#PRIVATE. A normal delete is deliberately limited to empty folders; recursive deletion is an explicit confirmation-protected tree action. Read-only identifiers are accepted and ignored when a GET representation is sent back unchanged.

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

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

{
    "id": "ae482pe37myq3fxz3w2m6yt8o",
    "parentId": "1w4pux6ywck6amymrmecbqbuf",
    "name": "string",
    "sharingMode": "PUBLIC",
    "members": [
        {
            "id": "2zqjz32jwc6ma8lklrvo5nnd0",
            "type": "group"
        }
    ]
}

Exposes HelpDesk form folders as a hierarchical WebAPI resource.

GET /api/helpdesk/forms/folders returns the protected root node with compact summaries of its direct forms and one shallow level of child summaries. Resolve a child folder for its direct contents; descendants are never embedded recursively. Individual folders support normal create, update, and delete operations. New folders default to FolderSharingMode#PRIVATE. A normal delete is deliberately limited to empty folders; recursive deletion is an explicit confirmation-protected tree action. Read-only identifiers are accepted and ignored when a GET representation is sent back unchanged.

# Request
PATCH /api/helpdesk/forms/folders/<folderId> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    "id": "31szhrzmhs55c9otxrtx9bl2i",
    "parentId": "aggnn9lfp337a21m0tcc8rycu",
    "name": "string",
    "sharingMode": "PUBLIC",
    "members": [
        {
            "id": "2zqjz32jwc6ma8lklrvo5nnd0",
            "type": "group"
        }
    ]
}

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

{
    "id": "ae482pe37myq3fxz3w2m6yt8o",
    "parentId": "1w4pux6ywck6amymrmecbqbuf",
    "name": "string",
    "sharingMode": "PUBLIC",
    "members": [
        {
            "id": "2zqjz32jwc6ma8lklrvo5nnd0",
            "type": "group"
        }
    ]
}

Exposes HelpDesk form folders as a hierarchical WebAPI resource.

GET /api/helpdesk/forms/folders returns the protected root node with compact summaries of its direct forms and one shallow level of child summaries. Resolve a child folder for its direct contents; descendants are never embedded recursively. Individual folders support normal create, update, and delete operations. New folders default to FolderSharingMode#PRIVATE. A normal delete is deliberately limited to empty folders; recursive deletion is an explicit confirmation-protected tree action. Read-only identifiers are accepted and ignored when a GET representation is sent back unchanged.

# Request
PUT /api/helpdesk/forms/folders/<folderId> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    "id": "31szhrzmhs55c9otxrtx9bl2i",
    "parentId": "aggnn9lfp337a21m0tcc8rycu",
    "name": "string",
    "sharingMode": "PUBLIC",
    "members": [
        {
            "id": "2zqjz32jwc6ma8lklrvo5nnd0",
            "type": "group"
        }
    ]
}

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

{
    "id": "ae482pe37myq3fxz3w2m6yt8o",
    "parentId": "1w4pux6ywck6amymrmecbqbuf",
    "name": "string",
    "sharingMode": "PUBLIC",
    "members": [
        {
            "id": "2zqjz32jwc6ma8lklrvo5nnd0",
            "type": "group"
        }
    ]
}

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.