DeleteFolderRequest

Request body for DeleteFolder.

Structure

{
  "folderPath": String,
  "retainFolderSettings": Boolean,
  "scope": String
}

{
  "folderPath": "/uploads",
  "retainFolderSettings": false,
  "scope": "All"
}

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

If true, does not delete folder settings at the folderPath or its descendants.

Default: false

Type: Boolean

Example: false

Required: No

Specifies which files and folders relative to the folderPath to delete.

•"All": deletes the files and folders that match or descend the path specified by folderPath.

•"Descendants": deletes the files and folders contained within folderPath and below, but not the folder itself.

•"ThisFolder": deletes the folder specified by folderPath if it contains no files and no sub-folders. Fails otherwise.

Default: "ThisFolder"

Type: String

Allowed Values: "All", "Descendants", "ThisFolder"

Example: "All"

Required: No

Was this section helpful? Yes No

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