Data Types


Copies multiple folders asynchronously.

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

POST /v2/accounts/{accountId}/folders/copy/batch
1curl "{accountId}/folders/copy/batch" \
2 -H "Authorization: Bearer YOUR_API_KEY" \
3 -H "Content-Type: application/json" \
4 -d @- << EOF
5 {
6 "folders": [
7 {
8 "condition": {
9 "equals": "*",
10 "type": "Equals"
11 },
12 "copyFiles": true,
13 "copyOverriddenStorage": false,
14 "copyVirtualFolders": true,
15 "destination": "/destination/folder",
16 "recursive": true,
17 "source": "/source/folder"
18 }
19 ]
20 }
Response (200)
2 "jobDocs": "",
3 "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
4 "jobType": "ExampleJob",
5 "jobUrl": ""

Request Body

Response Body

URL Parameters


Your account ID.

This is visible on the settings page:

Example: A623uY2

Type: String

Length: 7

In: Path

Required: Yes

Request Headers


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: