Data Types


Deletes multiple folders 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.

Requires a secret_* API key. Alternatively, you can use a public_* API key and JWT-based auth.

DELETE /v2/accounts/{accountId}/folders/batch
1curl "{accountId}/folders/batch" \
3 -H "Authorization: Bearer YOUR_API_KEY" \
4 -H "Content-Type: application/json" \
5 -d @- << EOF
6 {
7 "folders": [
8 {
9 "deleteFiles": true,
10 "deleteVirtualFolders": true,
11 "folderPath": "/uploads",
12 "recursive": true
13 }
14 ]
15 }
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

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 with apikey as your username and your API key as your password.

Note: this endpoint requires a secret_* API key.

Type: String

This endpoints requires a JSON request body.

Type: String

Value: "application/json"

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: