POST /2/files/upload_session/finish_batch
upload_session/finish_batch
scope: files.content.write
This route helps you commit many files at once into a user's Dropbox. Use upload_session/start
and upload_session/append:2
to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling upload_session/finish
, use this route to finish all your upload sessions in a single request.
UploadSessionStartArg.close
or UploadSessionAppendArg.close
needs to be true for the last upload_session/start
or upload_session/append:2
call. The maximum size of a file one can upload to an upload session is 350 GB.
This route will return a job_id immediately and do the async commit job in background. Use upload_session/finish_batch/check
to check the job status.
For the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request.
Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.
Servers
- https://api.dropboxapi.com
- https://content.dropboxapi.com
- https://notify.dropboxapi.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
dropbox-api-path-root |
String | No | |
dropbox-api-select-user |
String | No | |
dropbox-api-select-admin |
String | No |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
entries[] |
Array | No | |
entries[].commit |
Object | No | |
entries[].commit.autorename |
Boolean | No | |
entries[].commit.mode |
String | No | |
entries[].commit.mute |
Boolean | No | |
entries[].commit.strict_conflict |
Boolean | No | |
entries[].commit.path |
String | No | |
entries[].cursor |
Object | No | |
entries[].cursor.session_id |
String | No | |
entries[].cursor.offset |
Number | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.