Data Types

PutFolderRequest

Request body for PutFolder.

Structure

Example

{
"allowUnnamedFolder": false,
"folderPath": "/uploads",
"folderSettings": {
"description": {
"set": true,
"value": "This is an example folder description."
},
"publicPermissions": {
"set": true,
"value": [
{
"permissions": {
"file": {
"downloadFile": [
"thumbnail"
]
}
},
"scope": "Children"
}
]
},
"storageLayer": {
"set": true,
"value": {
"type": "InternalStorageV2"
}
}
}
}

Properties

allowUnnamedFolder

You must specify true if the folderPath ends with a /.

This prevents the accidental creation of folders that produce file paths with double forward-slashes in them.

Default: false

Type: Boolean

Example: false

Required: No

folderPath

Absolute path to a folder. Must begin with a /. Should not end with a /.

Type: String

Min Length: 1

Max Length: 512

Example: "/uploads"

Required: Yes

folderSettings

Specifies the folder settings to use when creating or updating a folder.

Type: PatchFolderSettings

Required: No

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: