Folders
/api/helpdesk/forms/folders/{folderId}/name
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.
GET /api/helpdesk/forms/folders/{folderId}/name
Required folder name. Root has an empty name and cannot be changed.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
folderId |
path | string |
yes | folder identifier from the URL |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request GET /api/helpdesk/forms/folders/<folderId>/name HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json "string"
PUT /api/helpdesk/forms/folders/{folderId}/name
Required folder name. Root has an empty name and cannot be changed.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
folderId |
path | string |
yes | folder identifier from the URL |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
string |
yes |
Required folder name. Root has an empty name and cannot be changed. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request PUT /api/helpdesk/forms/folders/<folderId>/name HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> Content-Type: application/json "string" # Response HTTP/1.1 200 OK Content-Type: application/json "string"
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 | — |