Data Types


Deletes a folder asynchronously.

If the folder has overridden storage settings, then no files will be deleted.

You can use ListFolder to preview the operation: set dryRun=true with recursive, includeFiles and includeVirtualFolders set to match the values you're using here. Leave all other flags unset.

DELETE /v2/accounts/{accountId}/folders
1curl "{accountId}/folders" \
3 -H "Authorization: Bearer YOUR_API_KEY" \
4 -H "Content-Type: application/json" \
5 -d @- << EOF
6 {
7 "deleteFiles": true,
8 "deleteVirtualFolders": true,
9 "folderPath": "/uploads",
10 "recursive": true
11 }
Response (200)
2 "jobDocs": "",
3 "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
4 "jobType": "ExampleJob",
5 "jobUrl": ""

Your account ID.

This is visible on the settings page:

Example: A623uY2

Type: String

Length: 7

In: Path

Required: Yes

Add one of these Authorization header values to your request:

Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.

Option 2: use HTTP basic authorization, specifying apikey as your username, and your API key as your password.

Type: String

In: Header

Required: Yes

This endpoints requires a JSON request body.

Type: String

Value: "application/json"

In: Header

Required: Yes

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: