Delete a folder

DELETE /api/2.0/files/folder/{folderId}

Request

Deletes a folder with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Path

folderIdstring

Folder ID

Body

deleteAfterboolean

Specifies whether to delete a folder after the editing session is finished or not

immediatelyboolean

Specifies whether to move a folder to the "Trash" folder or delete it immediately

Examples

DELETE /api/2.0/files/folder/%7BfolderId%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request DELETE \
  --url https://example.com/api/2.0/files/folder/%7BfolderId%7D \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of file operations

Idstring

OperationTypeenum of integerformat: int32

[0 - Move, 1 - Copy, 2 - Delete, 3 - Download, 4 - MarkAsRead, 5 - Import, 6 - Convert]

Can be one of: Move, Copy, Delete, Download, MarkAsRead, Import, Convert.

Progressintegerformat: int32

Errorstring

Processedstring

Finishedboolean

Urlstring

Filesarray of object

Namestring

UpdatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

Updatedstring

Locationstring

Foldersarray of object

ParentIdobject

FilesCountintegerformat: int32

FoldersCountintegerformat: int32

IsShareableboolean

IsFavoriteboolean

Idobject

Titlestring

Accessenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - FillForms, 8 - CustomFilter]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter.

Sharedboolean

Createdstring

CreatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

Updatedstring

RootFolderTypeenum of integerformat: int32

[0 - DEFAULT, 1 - COMMON, 2 - BUNCH, 3 - TRASH, 5 - USER, 6 - SHARE, 8 - Projects, 10 - Favorites, 11 - Recent, 12 - Templates, 13 - Privacy]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy.

UpdatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

ProviderItemboolean

ProviderKeystring

ProviderIdintegerformat: int32

DenyDownloadboolean

DenySharingboolean

401

Unauthorized