saveDefaultFolder
StudioDefaultPageSettingsWrapper saveDefaultFolder(DefaultProductRequestDto)
PUT /api/2.0/settings/defaultfolder
Set the default folder
Sets which folder the current user's account opens into by default, such as My Documents, the rooms list, or favorites. Requires an authenticated session; every role may set its own default, and the change never affects any other user. Only folder types the client actually offers as a landing page are accepted; picking My Documents (USER) as a Guest is rejected too, since guests have no personal storage. This is a mutating, idempotent call. It returns the saved setting.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| DefaultProductRequestDto | body | DefaultProductRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Saved default folder setting for the current user | StudioDefaultPageSettingsWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no defaultFolderType, the folder is not one a start page can be set to, or a guest chooses My documents | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
StudioDefaultPageSettingsWrapper
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json