Data Types


Request body for DeleteFolder.

You can use ListFolder to preview the operation using the dryRun parameter.

When deleting a folder with external storage: if the folder at folderPath has overridden storage settings (like an AWS S3 bucket), no files will be deleted, regardless of the parameters you pass. Only the mapping will be removed. If the folder at folderPath has inherited storage settings but includes subfolders with overridden storage settings, files in those subfolders won't be deleted, regardless of the parameters you pass. In summary, files in folders with overridden storage are never deleted, unless you directly delete a subfolder of such a folder.

"deleteFiles": Boolean,
"folderPath": String,
"recursive": Boolean
"deleteFiles": true,
"deleteVirtualFolders": true,
"folderPath": "/uploads",
"recursive": true

If true then deletes files.

Default: true

Type: Boolean

If true then deletes folder settings.

Default: true

Type: Boolean

The folder to delete.

Example: "/uploads"

Type: String

Min Length: 1

Max Length: 512

If true then deletes files and folder settings that descend folderPath.

If false then only deletes files that are direct children of folderPath and only deletes the folder settings of the current folder (if any). Does not delete the folder settings of any child or descendant folders.

Default: true

Type: Boolean

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: