Dropboxconnector v1.1

set_profile_photo

scope: account_info.write

Sets a user's profile photo.

Parameters

token/from_oauth1

scope: None

Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token.

Parameters

Options (2)

Option Name	Description
Oauth1 Token	The OAuth 1.0 token to be converted.
Oauth1 Token Secret	The OAuth 1.0 token secret associated with the token.

token/revoke

scope: None

Disables the access token used to authenticate the call.

Parameters

app

scope: None

This endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid.

Parameters

Options (1)

Option Name	Description
Query	A query string to include in the check request for debugging purposes.

user

scope: None

This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the access token is valid.

Parameters

Options (1)

Option Name	Description
Query	A query string to include in the check request for debugging purposes.

delete_manual_contacts

scope: contacts.write

Removes all manually added contacts. You'll still keep contacts who are on your team or who you imported. New contacts will be added when you share.

Parameters

delete_manual_contacts_batch

scope: contacts.write

Removes manually added contacts from the given list.

Parameters

Options (1)

Option Name	Description
Email Addresses	An array of email addresses identifying the manual contacts to delete.

devices/list_member_devices

scope: sessions.list

List all device sessions of a team's member.

Parameters

Options (4)

Option Name	Description
Team Member Id	The unique ID of the team member whose devices to list.
Include Web Sessions	Whether to include web session devices in the results.
Include Desktop Clients	Whether to include desktop client devices in the results.
Include Mobile Clients	Whether to include mobile client devices in the results.

devices/list_members_devices

scope: sessions.list

List all device sessions of a team.
Permission : Team member file access.

Parameters

devices/revoke_device_session

scope: sessions.modify

Revoke a device session of a team's member.

Parameters

Options (3)

Option Name	Description
.tag	The type of session to revoke (e.g., web, desktop, mobile).
Session Id	The unique identifier of the session to revoke.
Team Member Id	The team member ID associated with the session.

devices/revoke_device_session_batch

scope: sessions.modify

Revoke a list of device sessions of team members.

Parameters

Download a file or asset from Dropbox using a pre-signed URL with authorization. Use this action to retrieve file content directly.

Parameters

properties/add

scope: files.metadata.write

Add property groups to a Dropbox file. See templates/add_for_user or templates/add_for_team to create new templates.

Parameters

Options (1)

Option Name	Description
Path	The path to the file or folder to add properties to.

properties/overwrite

scope: files.metadata.write

Overwrite property groups associated with a file. This endpoint should be used instead of properties/update when property groups are being updated via a "snapshot" instead of via a "delta". In other words, this endpoint will delete all omitted fields from a property group, whereas properties/update will only delete fields that are explicitly marked for deletion.

Parameters

Options (1)

Option Name	Description
Path	The path to the file or folder whose properties to overwrite.

properties/remove

scope: files.metadata.write

Permanently removes the specified property group from the file. To remove specific property field key value pairs, see properties/update. To update a template, see templates/update_for_user or templates/update_for_team. To remove a template, see templates/remove_for_user or templates/remove_for_team.

Parameters

Options (2)

Option Name	Description
Path	The path to the file or folder to remove properties from.
Property Template Ids	An array of property template IDs to remove.

properties/search

scope: files.metadata.read

Search across property templates for particular property field values.

Parameters

Options (1)

Option Name	Description
Template Filter	A filter to narrow the search to a specific property template.

properties/search/continue

scope: files.metadata.read

Once a cursor has been retrieved from properties/search, use this to paginate through all search results.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

properties/update

scope: files.metadata.write

Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of properties/overwrite when property groups are being updated via a "delta" instead of via a "snapshot" . In other words, this endpoint will not delete any omitted fields from a property group, whereas properties/overwrite will delete any fields that are omitted from a property group.

Parameters

Options (1)

Option Name	Description
Path	The path to the file or folder whose properties to update.

templates/add_for_team

scope: files.team_metadata.write

Add a template associated with a team. See properties/add to add properties to a file or folder.
Note: this endpoint will create team-owned templates.

Parameters

Options (2)

Option Name	Description
Name	The name of the new property template.
Description	A description of the property template.

templates/add_for_user

scope: files.metadata.write

Add a template associated with a user. See properties/add to add properties to a file. This endpoint can't be called on a team member or admin's behalf.

Parameters

Options (2)

Option Name	Description
Name	The name of the new property template.
Description	A description of the property template.

templates/get_for_team

scope: files.team_metadata.write

Get the schema for a specified template.

Parameters

Options (1)

Option Name	Description
Template Id	The unique ID of the template to retrieve.

templates/get_for_user

scope: files.metadata.read

Get the schema for a specified template. This endpoint can't be called on a team member or admin's behalf.

Parameters

Options (1)

Option Name	Description
Template Id	The unique ID of the template to retrieve.

templates/list_for_team

scope: files.team_metadata.write

Get the template identifiers for a team. To get the schema of each template use templates/get_for_team.

Parameters

templates/list_for_user

scope: files.metadata.read

Get the template identifiers for a team. To get the schema of each template use templates/get_for_user. This endpoint can't be called on a team member or admin's behalf.

Parameters

templates/remove_for_team

scope: files.team_metadata.write

Permanently removes the specified template created from templates/add_for_user. All properties associated with the template will also be removed. This action cannot be undone.

Parameters

Options (1)

Option Name	Description
Template Id	The unique ID of the template to remove.

templates/remove_for_user

scope: files.metadata.write

Permanently removes the specified template created from templates/add_for_user. All properties associated with the template will also be removed. This action cannot be undone.

Parameters

Options (1)

Option Name	Description
Template Id	The unique ID of the template to remove.

templates/update_for_team

scope: files.team_metadata.write

Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates.

Parameters

Options (3)

Option Name	Description
Template Id	The unique ID of the template to remove.
Name	The name of the new property template.
Description	A description of the property template.

templates/update_for_user

scope: files.metadata.write

Update a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf.

Parameters

Options (3)

Option Name	Description
Template Id	The unique ID of the template to remove.
Name	The name of the new property template.
Description	A description of the property template.

count

scope: file_requests.read

Returns the total number of file requests owned by this user. Includes both open and closed file requests.

Parameters

create

scope: file_requests.write

Creates a file request for this user.

Parameters

Options (3)

Option Name	Description
Title	The title of the file request, displayed to recipients.
Destination	The path in the Dropbox where uploaded files will be stored.
Open	If true, the file request will be open immediately upon creation; if false, it will be closed.

delete

scope: file_requests.write

Delete a batch of closed file requests.

Parameters

Options (1)

Option Name	Description
Ids	A list of file request IDs to delete.

delete_all_closed

scope: file_requests.write

Delete all closed file requests owned by this user.

Parameters

get

scope: file_requests.read

Returns the specified file request.

Parameters

Options (1)

Option Name	Description
Id	The ID of the file request to retrieve.

list

scope: file_requests.read

Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.

Parameters

Options (1)

Option Name	Description
Limit	The maximum number of file requests to return in a single response.

list/continue

scope: file_requests.read

Once a cursor has been retrieved from list:2, use this to paginate through all file requests. The cursor must come from a previous call to list:2 or list/continue.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

update

scope: file_requests.write

Update a file request.

Parameters

Options (4)

Option Name	Description
Id	The ID of the file request to update.
Title	The new title for the file request.
Destination	The new destination path for uploaded files.
Open	Whether the file request should be open (true) or closed (false) after the update.

copy

scope: files.content.write

Copy a file or folder to a different location in the user's Dropbox.
If the source path is a folder all its contents will be copied.

Parameters

Options (5)

Option Name	Description
From Path	The path of the file or folder to copy.
To Path	The destination path for the copy.
Allow Shared Folder	If true, allows copying into a shared folder; if false, copying into a shared folder is disallowed.
Autorename	If true, automatically renames the copy if a conflict occurs at the destination.
Allow Ownership Transfer	If true, allows the copy to transfer ownership if copying into a shared folder.

copy_batch

scope: files.content.write

Copy multiple files or folders to different locations at once in the user's Dropbox.
This route will replace copy_batch:1. The main difference is this route will return status for each entry, while copy_batch:1 raises failure if any entry fails.
This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use copy_batch/check:2 to check the job status.

Parameters

Options (1)

Option Name	Description
Autorename	If true, automatically renames items when a conflict occurs during the batch copy.

copy_batch/check

scope: files.content.write

Returns the status of an asynchronous job for copy_batch:2. It returns list of results for each entry.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

copy_reference/get

scope: files.content.write

Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to copy_reference/save.

Parameters

Options (1)

Option Name	Description
Path	The path to the file or folder whose properties to update.

copy_reference/save

scope: files.content.write

Save a copy reference returned by copy_reference/get to the user's Dropbox.

Parameters

Options (2)

Option Name	Description
Copy Reference	The copy reference string obtained from a file's share link or copy reference endpoint.
Path	The path to the file or folder whose properties to update.

create_folder

scope: files.content.write

Create a folder at a given path.

Parameters

Options (2)

Option Name	Description
Path	The path to the file or folder whose properties to update.
Autorename	If true, automatically renames the folder if a conflict exists at the destination.

create_folder_batch

scope: files.content.write

Create multiple folders at once.
This route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the CreateFolderBatchArg.force_async flag. Use create_folder_batch/check to check the job status.

Parameters

Options (3)

Option Name	Description
Paths	A list of paths where folders should be created.
Autorename	If true, automatically renames folders when a conflict occurs.
Force Async	If true, forces the operation to be performed asynchronously even if it could be done synchronously.

create_folder_batch/check

scope: files.content.write

Returns the status of an asynchronous job for create_folder_batch. If success, it returns list of result for each entry.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

delete

scope: files.content.write

Delete the file or folder at a given path.
If the path is a folder, all its contents will be deleted too.
A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

Parameters

Options (1)

Option Name	Description
Path	The path to the file or folder whose properties to update.

delete_batch

scope: files.content.write

Delete multiple files/folders at once.
This route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use delete_batch/check to check the job status.

Parameters

delete_batch/check

scope: files.content.write

Returns the status of an asynchronous job for delete_batch. If success, it returns list of result for each entry.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

download

scope: files.content.read

Download a file from a user's Dropbox.

Parameters

download_zip

scope: files.content.read

Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size.

Parameters

export

scope: files.content.read

Export a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose ExportResult.file_metadata has ExportInfo.export_as populated.

Parameters

get_file_lock_batch

scope: files.content.read

Return the lock metadata for the given list of paths.

Parameters

get_metadata

scope: files.metadata.read

Returns the metadata for a file or folder.
Note: Metadata for the root folder is unsupported.

Parameters

Options (4)

Option Name	Description
Include Deleted	If true, include metadata for deleted files or folders in the response.
Include Has Explicit Shared Members	If true, include information about whether the item has explicit shared members.
Include Media Info	If true, include media metadata such as dimensions and duration for supported file types.
Path	The path to the file or folder whose properties to update.

get_preview

scope: files.content.read

Get a preview for a file.
Currently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf.
HTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx.
Other formats will return an unsupported extension error.

Parameters

get_temporary_link

scope: files.content.read

Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type.

Parameters

Options (1)

Option Name	Description
Path	The path to the file or folder whose properties to update.

get_temporary_upload_link

scope: files.content.write

Get a one-time use temporary upload link to upload a file to a Dropbox location.

This endpoint acts as a delayed upload. The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the CommitInfo previously provided to get_temporary_upload_link but evaluated only upon consumption. Hence, errors stemming from invalid CommitInfo with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time.

The POST request on the temporary upload link must have its Content-Type set to "application/octet-stream".

Example temporary upload link consumption request:

curl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND
--header "Content-Type: application/octet-stream"
--data-binary @local_file.txt

A successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format.

Example succesful temporary upload link consumption response:
{"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"}

An unsuccessful temporary upload link consumption request returns any of the following status codes:

HTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid.
HTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened.
HTTP 410 Gone: The temporary upload link is expired or consumed.

Example unsuccessful temporary upload link consumption response:
Temporary upload link has been recently consumed.

Parameters

Options (1)

Option Name	Description
Duration	The duration in seconds for which the temporary upload link remains valid.

get_thumbnail

scope: files.content.read

Get a thumbnail for a file.

Parameters

get_thumbnail_batch

scope: files.content.read

Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch.
This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Parameters

list_folder

scope: files.metadata.read

Starts returning the contents of a folder. If the result's ListFolderResult.has_more field is true, call list_folder/continue with the returned ListFolderResult.cursor to retrieve more entries.
If you're using ListFolderArg.recursive set to true to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync:
For each FileMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children.
For each FolderMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's FolderSharingInfo.read_only and set all its children's read-only statuses to match.
For each DeletedMetadata, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry.
Note: auth.RateLimitError may be returned if multiple list_folder or list_folder/continue calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.

Parameters

Options (7)

Option Name	Description
Include Deleted	If true, include deleted files in the folder listing.
Include Has Explicit Shared Members	If true, include information about whether each item has explicit shared members.
Include Media Info	If true, include media metadata for supported files in the listing.
Include Mounted Folders	If true, include mounted folders in the listing.
Include Non Downloadable Files	If true, include files that are not downloadable in the listing.
Path	The path to the file or folder whose properties to update.
Recursive	If true, list contents of subfolders recursively.

list_folder/continue

scope: files.metadata.read

Once a cursor has been retrieved from list_folder, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for list_folder.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

list_folder/get_latest_cursor

scope: files.metadata.read

A way to quickly get a cursor for the folder's state. Unlike list_folder, list_folder/get_latest_cursor doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.

Parameters

Options (7)

Option Name	Description
Path	The path to the file or folder whose properties to update.
Recursive	If true, include subfolders recursively when determining the cursor.
Include Media Info	If true, include media metadata in the cursor context.
Include Deleted	If true, include deleted files in the cursor context.
Include Has Explicit Shared Members	If true, include explicit shared member info in the cursor context.
Include Mounted Folders	If true, include mounted folders in the cursor context.
Include Non Downloadable Files	If true, include non-downloadable files in the cursor context.

list_folder/longpoll

scope: files.metadata.read

A longpoll endpoint to wait for changes on an account. In conjunction with list_folder/continue, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps. If you're looking for server-side notifications, check out our webhooks documentation.

Parameters

Options (2)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.
Timeout	The maximum time in seconds to wait for a response before returning.

list_revisions

scope: files.metadata.read

Returns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately.
In the ListRevisionsMode.path (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to ListRevisionsMode.id. The ListRevisionsMode.id mode is useful to retrieve revisions for a given file across moves or renames.

Parameters

Options (3)

Option Name	Description
Path	The path to the file or folder whose properties to update.
Mode	The sorting mode for revisions, such as 'path' or 'id', which determines the order of returned revisions.
Limit	The maximum number of file requests to return in a single response.

lock_file_batch

scope: files.content.write

Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.

Parameters

move

scope: files.content.write

Move a file or folder to a different location in the user's Dropbox.
If the source path is a folder all its contents will be moved.
Note that we do not currently support case-only renaming.

Parameters

Options (5)

Option Name	Description
From Path	The path of the file or folder to copy.
To Path	The destination path for the copy.
Allow Shared Folder	If true, allows copying into a shared folder; if false, copying into a shared folder is disallowed.
Autorename	If true, automatically renames folders when a conflict occurs.
Allow Ownership Transfer	If true, allows the copy to transfer ownership if copying into a shared folder.

move_batch

scope: files.content.write

Move multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming.
This route will replace move_batch:1. The main difference is this route will return status for each entry, while move_batch:1 raises failure if any entry fails.
This route will either finish synchronously, or return a job ID and do the async move job in background. Please use move_batch/check:2 to check the job status.

Parameters

Options (2)

Option Name	Description
Autorename	If true, automatically renames folders when a conflict occurs.
Allow Ownership Transfer	If true, allows the copy to transfer ownership if copying into a shared folder.

move_batch/check

scope: files.content.write

Returns the status of an asynchronous job for move_batch:2. It returns list of results for each entry.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

permanently_delete

scope: files.permanent_delete

Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).
Note: This endpoint is only available for Dropbox Business apps.

Parameters

Options (1)

Option Name	Description
Path	The path to the file or folder whose properties to update.

restore

scope: files.content.write

Restore a specific revision of a file to the given path.

Parameters

Options (2)

Option Name	Description
Path	The path to the file or folder whose properties to update.
Rev	The revision identifier of the file to restore, typically obtained from a previous list or delete operation.

save_url

scope: files.content.write

Save the data from a specified URL into a file in user's Dropbox.
Note that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail.
If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).

Parameters

Options (2)

Option Name	Description
Path	The path to the file or folder whose properties to update.
Url	The URL of the file to save.

save_url/check_job_status

scope: files.content.write

Check the status of a save_url job.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

search

scope: files.metadata.read

Searches for files and folders.
Note: search:2 along with search/continue:2 can only be used to retrieve a maximum of 10,000 matches.
Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Parameters

Options (1)

Option Name	Description
Query	A query string to include in the check request for debugging purposes.

search/continue

scope: files.metadata.read

Fetches the next page of search results returned from search:2.
Note: search:2 along with search/continue:2 can only be used to retrieve a maximum of 10,000 matches.
Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

unlock_file_batch

scope: files.content.write

Unlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.

Parameters

upload

scope: files.content.write

Create a new file with the contents provided in the request.
Do not use this to upload a file larger than 150 MB. Instead, create an upload session with upload_session/start.
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.

Parameters

Options (1)

Option Name	Description
File	The file content to upload, provided as a string representation (e.g., base64-encoded data).

upload_session/append

scope: files.content.write

Append more data to an upload session.
When the parameter close is set, this call will close the session.
A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.
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.

Parameters

upload_session/finish

scope: files.content.write

Finish an upload session and save the uploaded data to the given file path.
A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.
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.

Parameters

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.

Parameters

upload_session/finish_batch/check

scope: files.content.write

Returns the status of an asynchronous job for upload_session/finish_batch. If success, it returns list of result for each entry.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

upload_session/start

scope: files.content.write

Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. This call starts a new upload session with the given data. You can then use upload_session/append:2 to add more data and upload_session/finish to save all the data to a file in Dropbox.
A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.
An upload session can be used for a maximum of 48 hours. Attempting to use an UploadSessionStartResult.session_id with upload_session/append:2 or upload_session/finish more than 48 hours after its creation will return a UploadSessionLookupError.not_found.
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.

Parameters

groups/create

scope: groups.write

Creates a new, empty group, with a requested name.
Permission : Team member management.

Parameters

Options (3)

Option Name	Description
Group Name	The name for the new group.
Add Creator As Owner	Whether the group creator should be added as an owner of the group.
Group External Id	An external ID for the group, used to link with an external system.

groups/delete

scope: groups.write

Deletes a group.
The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the groups/job_status/get to determine whether this process has completed.
Permission : Team member management.

Parameters

Options (2)

Option Name	Description
.tag	The type of session to revoke (e.g., web, desktop, mobile).
Group Id	The identifier of the group to delete.

groups/get_info

scope: groups.read

Retrieves information about one or more groups. Note that the optional field GroupFullInfo.members is not returned for system-managed groups.
Permission : Team Information.

Parameters

Options (2)

Option Name	Description
.tag	The type of session to revoke (e.g., web, desktop, mobile).
Group Ids	A list of group identifiers for which to retrieve information.

groups/job_status/get

scope: groups.write

Once an async_job_id is returned from groups/delete, groups/members/add , or groups/members/remove use this method to poll the status of granting/revoking group members' access to group-owned resources.
Permission : Team member management.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

groups/list

scope: groups.read

Lists groups on a team.
Permission : Team Information.

Parameters

Options (1)

Option Name	Description
Limit	The maximum number of file requests to return in a single response.

groups/list/continue

scope: groups.read

Once a cursor has been retrieved from groups/list, use this to paginate through all groups.
Permission : Team Information.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

groups/members/add

scope: groups.write

Adds members to a group.
The members are added immediately. However the granting of group-owned resources may take additional time. Use the groups/job_status/get to determine whether this process has completed.
Permission : Team member management.

Parameters

Options (1)

Option Name	Description
Return Members	Whether to return the updated list of group members after the operation.

groups/members/list

scope: groups.read

Lists members of a group.
Permission : Team Information.

Parameters

Options (1)

Option Name	Description
Limit	The maximum number of file requests to return in a single response.

groups/members/list/continue

scope: groups.read

Once a cursor has been retrieved from groups/members/list, use this to paginate through all members of the group.
Permission : Team information.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

groups/members/remove

scope: groups.write

Removes members from a group.
The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groups/job_status/get to determine whether this process has completed.
This method permits removing the only owner of a group, even in cases where this is not possible via the web client.
Permission : Team member management.

Parameters

Options (1)

Option Name	Description
Return Members	Whether to return the updated list of group members after the operation.

groups/members/set_access_type

scope: groups.write

Sets a member's access type in a group.
Permission : Team member management.

Parameters

Options (2)

Option Name	Description
Access Type	The new access type to assign to the members, such as "owner" or "member".
Return Members	Whether to return the updated list of group members after the operation.

groups/update

scope: groups.write

Updates a group's name and/or external ID.
Permission : Team member management.

Parameters

Options (4)

Option Name	Description
Return Members	Whether to return the updated list of group members after the operation.
New Group Name	The new name to assign to the group.
New Group External Id	The new external ID to assign to the group.
New Group Management Type	The new management type for the group, for example "user_managed" or "company_managed".

legal_holds/create_policy

scope: team_data.member

Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.

Parameters

Options (4)

Option Name	Description
Name	The name of the new property template.
Members	The list of member IDs to apply the legal hold to.
Start Date	The start date for the legal hold policy, in the format YYYY-MM-DD.
End Date	The end date for the legal hold policy, in the format YYYY-MM-DD.

legal_holds/get_policy

scope: team_data.member

Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.

Parameters

Options (1)

Option Name	Description
Id	The ID of the file request to update.

legal_holds/list_held_revisions

scope: team_data.member

List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.

Parameters

Options (1)

Option Name	Description
Id	The ID of the file request to update.

legal_holds/list_held_revisions_continue

scope: team_data.member

Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.

Parameters

Options (1)

Option Name	Description
Id	The ID of the file request to update.

legal_holds/list_policies

scope: team_data.member

Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.

Parameters

Options (1)

Option Name	Description
Include Released	Whether to include policies that have been released; set to true to include them.

legal_holds/release_policy

scope: team_data.member

Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.

Parameters

Options (1)

Option Name	Description
Id	The ID of the file request to update.

legal_holds/update_policy

scope: team_data.member

Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.

Parameters

Options (2)

Option Name	Description
Id	The ID of the file request to update.
Members	The updated list of member IDs for the legal hold policy.

linked_apps/list_member_linked_apps

scope: sessions.list

List all linked applications of the team member.
Note, this endpoint does not list any team-linked applications.

Parameters

Options (1)

Option Name	Description
Team Member Id	The team member ID associated with the session.

linked_apps/list_members_linked_apps

scope: sessions.list

List all applications linked to the team members' accounts.
Note, this endpoint does not list any team-linked applications.

Parameters

linked_apps/revoke_linked_app

scope: sessions.modify

Revoke a linked application of the team member.

Parameters

linked_apps/revoke_linked_app_batch

scope: sessions.modify

Revoke a list of linked applications of the team members.

Parameters

member_space_limits/excluded_users/add

scope: members.write

Add users to member space limits excluded users list.

Parameters

member_space_limits/excluded_users/list

scope: members.read

List member space limits excluded users.

Parameters

Options (1)

Option Name	Description
Limit	The maximum number of file requests to return in a single response.

member_space_limits/excluded_users/list/continue

scope: members.read

Continue listing member space limits excluded users.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

member_space_limits/excluded_users/remove

scope: members.write

Remove users from member space limits excluded users list.

Parameters

member_space_limits/get_custom_quota

scope: members.read

Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.

Parameters

member_space_limits/remove_custom_quota

scope: members.write

Remove users custom quota. A maximum of 1000 members can be specified in a single call.

Parameters

member_space_limits/set_custom_quota

scope: members.read

Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.

Parameters

members/add

scope: members.write

Adds members to a team.
Permission : Team member management
A maximum of 20 members can be specified in a single call.
If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.
If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.
Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.

Parameters

Options (1)

Option Name	Description
Force Async	If true, forces the operation to be performed asynchronously even if it could be done synchronously.

members/add/job_status/get

scope: members.write

Once an async_job_id is returned from members/add , use this to poll the status of the asynchronous request.
Permission : Team member management.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

members/delete_profile_photo

scope: members.write

Deletes a team member's profile photo.
Permission : Team member management.

Parameters

members/get_info

scope: members.read

Returns information about multiple team members.
Permission : Team information
This endpoint will return MembersGetInfoItem.id_not_found, for IDs (or emails) that cannot be matched to a valid team member.

Parameters

members/list

scope: members.read

Lists members of a team.
Permission : Team information.

Parameters

Options (2)

Option Name	Description
Limit	The maximum number of file requests to return in a single response.
Include Removed	Whether to include members who have been removed from the team; set to true to include them.

members/list/continue

scope: members.read

Once a cursor has been retrieved from members/list, use this to paginate through all team members.
Permission : Team information.

Parameters

Options (1)

Option Name	Description
Cursor	The cursor returned from a previous search request to continue pagination.

members/move_former_member_files

scope: members.write

Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll members/move_former_member_files/job_status/check.
Permission : Team member management.

Parameters

members/move_former_member_files/job_status/check

scope: members.write

Once an async_job_id is returned from members/move_former_member_files , use this to poll the status of the asynchronous request.
Permission : Team member management.

Parameters

Options (1)

Option Name	Description
Async Job Id	The ID of the asynchronous job to check.

members/recover

scope: members.delete

Recover a deleted member.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

Parameters