-
accountSetProfilePhoto(arg)
-
Sets a user's profile photo.
Route attributes:
scope: account_info.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AccountSetProfilePhotoResult>, DropboxResponseError.<AccountSetProfilePhotoError>>
-
authTokenFromOauth1(arg)
-
Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token.
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AuthTokenFromOAuth1Result>, DropboxResponseError.<AuthTokenFromOAuth1Error>>
-
authTokenRevoke()
-
Disables the access token used to authenticate the call. If there is a
corresponding refresh token for the access token, this disables that refresh
token, as well as any other access tokens for that refresh token.
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<void>>
-
checkApp(arg)
-
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:
| Name |
Type |
Description |
arg |
CheckEchoArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<CheckEchoResult>, DropboxResponseError.<void>>
-
checkUser(arg)
-
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.
Route attributes:
scope: account_info.read
Parameters:
| Name |
Type |
Description |
arg |
CheckEchoArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<CheckEchoResult>, DropboxResponseError.<void>>
-
-
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.
Route attributes:
scope: contacts.write
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<void>>
-
-
Removes manually added contacts from the given list.
Route attributes:
scope: contacts.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<ContactsDeleteManualContactsError>>
-
filePropertiesPropertiesAdd(arg)
-
Add property groups to a Dropbox file. See templates/add_for_user or
templates/add_for_team to create new templates.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesAddPropertiesError>>
-
filePropertiesPropertiesOverwrite(arg)
-
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.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesInvalidPropertyGroupError>>
-
filePropertiesPropertiesRemove(arg)
-
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.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesRemovePropertiesError>>
-
filePropertiesPropertiesSearch(arg)
-
Search across property templates for particular property field values.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesPropertiesSearchResult>, DropboxResponseError.<FilePropertiesPropertiesSearchError>>
-
filePropertiesPropertiesSearchContinue(arg)
-
Once a cursor has been retrieved from properties/search, use this to paginate
through all search results.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesPropertiesSearchResult>, DropboxResponseError.<FilePropertiesPropertiesSearchContinueError>>
-
filePropertiesPropertiesUpdate(arg)
-
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.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesUpdatePropertiesError>>
-
filePropertiesTemplatesAddForTeam(arg)
-
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.
Route attributes:
scope: files.team_metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesAddTemplateResult>, DropboxResponseError.<FilePropertiesModifyTemplateError>>
-
filePropertiesTemplatesAddForUser(arg)
-
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.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesAddTemplateResult>, DropboxResponseError.<FilePropertiesModifyTemplateError>>
-
filePropertiesTemplatesGetForTeam(arg)
-
Get the schema for a specified template.
Route attributes:
scope: files.team_metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesGetTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filePropertiesTemplatesGetForUser(arg)
-
Get the schema for a specified template. This endpoint can't be called on a
team member or admin's behalf.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesGetTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filePropertiesTemplatesListForTeam()
-
Get the template identifiers for a team. To get the schema of each template
use templates/get_for_team.
Route attributes:
scope: files.team_metadata.write
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesListTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filePropertiesTemplatesListForUser()
-
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.
Route attributes:
scope: files.metadata.read
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesListTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filePropertiesTemplatesRemoveForTeam(arg)
-
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.
Route attributes:
scope: files.team_metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filePropertiesTemplatesRemoveForUser(arg)
-
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.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filePropertiesTemplatesUpdateForTeam(arg)
-
Update a template associated with a team. This route can update the template
name, the template description and add optional properties to templates.
Route attributes:
scope: files.team_metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesUpdateTemplateResult>, DropboxResponseError.<FilePropertiesModifyTemplateError>>
-
filePropertiesTemplatesUpdateForUser(arg)
-
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.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesUpdateTemplateResult>, DropboxResponseError.<FilePropertiesModifyTemplateError>>
-
fileRequestsCount()
-
Returns the total number of file requests owned by this user. Includes both
open and closed file requests.
Route attributes:
scope: file_requests.read
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsCountFileRequestsResult>, DropboxResponseError.<FileRequestsCountFileRequestsError>>
-
fileRequestsCreate(arg)
-
Creates a file request for this user.
Route attributes:
scope: file_requests.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsFileRequest>, DropboxResponseError.<FileRequestsCreateFileRequestError>>
-
fileRequestsDelete(arg)
-
Delete a batch of closed file requests.
Route attributes:
scope: file_requests.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsDeleteFileRequestsResult>, DropboxResponseError.<FileRequestsDeleteFileRequestError>>
-
fileRequestsDeleteAllClosed()
-
Delete all closed file requests owned by this user.
Route attributes:
scope: file_requests.write
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsDeleteAllClosedFileRequestsResult>, DropboxResponseError.<FileRequestsDeleteAllClosedFileRequestsError>>
-
fileRequestsGet(arg)
-
Returns the specified file request.
Route attributes:
scope: file_requests.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsFileRequest>, DropboxResponseError.<FileRequestsGetFileRequestError>>
-
fileRequestsList()
-
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.
Route attributes:
scope: file_requests.read
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsListFileRequestsResult>, DropboxResponseError.<FileRequestsListFileRequestsError>>
-
fileRequestsListContinue(arg)
-
Once a cursor has been retrieved from list_v2, use this to paginate through
all file requests. The cursor must come from a previous call to list_v2 or
list/continue.
Route attributes:
scope: file_requests.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsListFileRequestsV2Result>, DropboxResponseError.<FileRequestsListFileRequestsContinueError>>
-
fileRequestsListV2(arg)
-
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.
Route attributes:
scope: file_requests.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsListFileRequestsV2Result>, DropboxResponseError.<FileRequestsListFileRequestsError>>
-
fileRequestsUpdate(arg)
-
Update a file request.
Route attributes:
scope: file_requests.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FileRequestsFileRequest>, DropboxResponseError.<FileRequestsUpdateFileRequestError>>
-
-
Returns the metadata for a file or folder. This is an alpha endpoint
compatible with the properties API. Note: Metadata for the root folder is
unsupported.
Route attributes:
scope: files.metadata.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesAlphaGetMetadataError>>
-
filesAlphaUpload(arg)
-
Create a new file with the contents provided in the request. Note that the
behavior of this alpha endpoint is unstable and subject to change. Do not use
this to upload a file larger than 150 MB. Instead, create an upload session
with upload_session/start.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFileMetadata>, DropboxResponseError.<FilesUploadError>>
-
filesCopy(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesRelocationError>>
-
filesCopyBatch(arg)
-
Copy multiple files or folders to different locations at once in the user's
Dropbox. This route will return job ID immediately and do the async copy job
in background. Please use copy_batch/check to check the job status.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchLaunch>, DropboxResponseError.<void>>
-
filesCopyBatchCheck(arg)
-
Returns the status of an asynchronous job for copy_batch. If success, it
returns list of results for each entry.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchJobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesCopyBatchCheckV2(arg)
-
Returns the status of an asynchronous job for copy_batch_v2. It returns list
of results for each entry.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchV2JobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesCopyBatchV2(arg)
-
Copy multiple files or folders to different locations at once in the user's
Dropbox. This route will replace copy_batch. The main difference is this
route will return status for each entry, while copy_batch 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_v2 to
check the job status.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
Object
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchV2Launch>, DropboxResponseError.<void>>
-
filesCopyReferenceGet(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesGetCopyReferenceResult>, DropboxResponseError.<FilesGetCopyReferenceError>>
-
filesCopyReferenceSave(arg)
-
Save a copy reference returned by copy_reference/get to the user's Dropbox.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesSaveCopyReferenceResult>, DropboxResponseError.<FilesSaveCopyReferenceError>>
-
filesCopyV2(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationResult>, DropboxResponseError.<FilesRelocationError>>
-
filesCreateFolder(arg)
-
Create a folder at a given path.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFolderMetadata>, DropboxResponseError.<FilesCreateFolderError>>
-
filesCreateFolderBatch(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesCreateFolderBatchLaunch>, DropboxResponseError.<void>>
-
filesCreateFolderBatchCheck(arg)
-
Returns the status of an asynchronous job for create_folder_batch. If
success, it returns list of result for each entry.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesCreateFolderBatchJobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesCreateFolderV2(arg)
-
Create a folder at a given path.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesCreateFolderResult>, DropboxResponseError.<FilesCreateFolderError>>
-
filesDelete(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesDeleteError>>
-
filesDeleteBatch(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesDeleteBatchLaunch>, DropboxResponseError.<void>>
-
filesDeleteBatchCheck(arg)
-
Returns the status of an asynchronous job for delete_batch. If success, it
returns list of result for each entry.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesDeleteBatchJobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesDeleteV2(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesDeleteResult>, DropboxResponseError.<FilesDeleteError>>
-
filesDownload(arg)
-
Download a file from a user's Dropbox.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFileMetadata>, DropboxResponseError.<FilesDownloadError>>
-
filesDownloadZip(arg)
-
Download a folder from the user's Dropbox, as a zip file. The folder must be
less than 20 GB in size and any single file within must be less than 4 GB in
size. The resulting zip must have fewer than 10,000 total file and folder
entries, including the top level folder. The input cannot be a single file.
Note: this endpoint does not support HTTP range requests.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesDownloadZipResult>, DropboxResponseError.<FilesDownloadZipError>>
-
filesExport(arg)
-
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.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesExportResult>, DropboxResponseError.<FilesExportError>>
-
filesGetFileLockBatch(arg)
-
Return the lock metadata for the given list of paths.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesLockFileBatchResult>, DropboxResponseError.<FilesLockFileError>>
-
-
Returns the metadata for a file or folder. Note: Metadata for the root folder
is unsupported.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesGetMetadataError>>
-
filesGetPreview(arg)
-
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.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFileMetadata>, DropboxResponseError.<FilesPreviewError>>
-
filesGetTemporaryLink(arg)
-
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.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesGetTemporaryLinkResult>, DropboxResponseError.<FilesGetTemporaryLinkError>>
-
filesGetTemporaryUploadLink(arg)
-
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 successful 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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesGetTemporaryUploadLinkResult>, DropboxResponseError.<void>>
-
filesGetThumbnail(arg)
-
Get a thumbnail for an image. This method currently supports files with the
following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp.
Photos that are larger than 20MB in size won't be converted to a thumbnail.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFileMetadata>, DropboxResponseError.<FilesThumbnailError>>
-
filesGetThumbnailBatch(arg)
-
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, webp, ppm and bmp. Photos that
are larger than 20MB in size won't be converted to a thumbnail.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesGetThumbnailBatchResult>, DropboxResponseError.<FilesGetThumbnailBatchError>>
-
filesGetThumbnailV2(arg)
-
Get a thumbnail for an image. This method currently supports files with the
following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp.
Photos that are larger than 20MB in size won't be converted to a thumbnail.
Route attributes:
scope: files.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesPreviewResult>, DropboxResponseError.<FilesThumbnailV2Error>>
-
filesListFolder(arg)
-
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.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesListFolderResult>, DropboxResponseError.<FilesListFolderError>>
-
filesListFolderContinue(arg)
-
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.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesListFolderResult>, DropboxResponseError.<FilesListFolderContinueError>>
-
filesListFolderGetLatestCursor(arg)
-
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.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesListFolderGetLatestCursorResult>, DropboxResponseError.<FilesListFolderError>>
-
filesListFolderLongpoll(arg)
-
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 https://www.dropbox.com/developers/reference/webhooks.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesListFolderLongpollResult>, DropboxResponseError.<FilesListFolderLongpollError>>
-
filesListRevisions(arg)
-
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.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesListRevisionsResult>, DropboxResponseError.<FilesListRevisionsError>>
-
filesLockFileBatch(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesLockFileBatchResult>, DropboxResponseError.<FilesLockFileError>>
-
filesMove(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesRelocationError>>
-
filesMoveBatch(arg)
-
Move multiple files or folders to different locations at once in the user's
Dropbox. This route will return job ID immediately and do the async moving
job in background. Please use move_batch/check to check the job status.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchLaunch>, DropboxResponseError.<void>>
-
filesMoveBatchCheck(arg)
-
Returns the status of an asynchronous job for move_batch. If success, it
returns list of results for each entry.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchJobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesMoveBatchCheckV2(arg)
-
Returns the status of an asynchronous job for move_batch_v2. It returns list
of results for each entry.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchV2JobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesMoveBatchV2(arg)
-
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. The main difference is this route will return status
for each entry, while move_batch 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_v2 to check the job
status.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationBatchV2Launch>, DropboxResponseError.<void>>
-
filesMoveV2(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesRelocationResult>, DropboxResponseError.<FilesRelocationError>>
-
filesPaperCreate(arg)
-
Creates a new Paper doc with the provided content.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesPaperCreateResult>, DropboxResponseError.<FilesPaperCreateError>>
-
filesPaperUpdate(arg)
-
Updates an existing Paper doc with the provided content.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesPaperUpdateResult>, DropboxResponseError.<FilesPaperUpdateError>>
-
filesPermanentlyDelete(arg)
-
Permanently delete the file or folder at a given path (see
https://www.dropbox.com/en/help/40). If the given file or folder is not yet
deleted, this route will first delete it. It is possible for this route to
successfully delete, then fail to permanently delete. Note: This endpoint is
only available for Dropbox Business apps.
Route attributes:
scope: files.permanent_delete
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilesDeleteError>>
-
filesPropertiesAdd(arg)
-
Route attributes:
scope: files.metadata.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesAddPropertiesError>>
-
filesPropertiesOverwrite(arg)
-
Route attributes:
scope: files.metadata.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesInvalidPropertyGroupError>>
-
filesPropertiesRemove(arg)
-
Route attributes:
scope: files.metadata.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesRemovePropertiesError>>
-
filesPropertiesTemplateGet(arg)
-
Route attributes:
scope: files.metadata.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesGetTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filesPropertiesTemplateList()
-
Route attributes:
scope: files.metadata.read
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesListTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
filesPropertiesUpdate(arg)
-
Route attributes:
scope: files.metadata.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilePropertiesUpdatePropertiesError>>
-
filesRestore(arg)
-
Restore a specific revision of a file to the given path.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFileMetadata>, DropboxResponseError.<FilesRestoreError>>
-
filesSaveUrl(arg)
-
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).
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesSaveUrlResult>, DropboxResponseError.<FilesSaveUrlError>>
-
filesSaveUrlCheckJobStatus(arg)
-
Check the status of a save_url job.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesSaveUrlJobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesSearch(arg)
-
Searches for files and folders. Note: Recent changes will be reflected in
search results within a few seconds and older revisions of existing files may
still match your query for up to a few days.
Route attributes:
scope: files.metadata.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesSearchResult>, DropboxResponseError.<FilesSearchError>>
-
filesSearchContinueV2(arg)
-
Fetches the next page of search results returned from search_v2. Note:
search_v2 along with search/continue_v2 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.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesSearchV2Result>, DropboxResponseError.<FilesSearchError>>
-
filesSearchV2(arg)
-
Searches for files and folders. Note: search_v2 along with search/continue_v2
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.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesSearchV2Result>, DropboxResponseError.<FilesSearchError>>
-
-
Add a tag to an item. A tag is a string. The strings are automatically
converted to lowercase letters. No more than 20 tags can be added to a given
item.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilesAddTagError>>
-
-
Get list of tags assigned to items.
Route attributes:
scope: files.metadata.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesGetTagsResult>, DropboxResponseError.<FilesBaseTagError>>
-
-
Remove a tag from an item.
Route attributes:
scope: files.metadata.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilesRemoveTagError>>
-
filesUnlockFileBatch(arg)
-
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.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesLockFileBatchResult>, DropboxResponseError.<FilesLockFileError>>
-
filesUpload(arg)
-
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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFileMetadata>, DropboxResponseError.<FilesUploadError>>
-
filesUploadSessionAppend(arg)
-
Append more data to an upload 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 https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilesUploadSessionAppendError>>
-
filesUploadSessionAppendV2(arg)
-
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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<FilesUploadSessionAppendError>>
-
filesUploadSessionFinish(arg)
-
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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesFileMetadata>, DropboxResponseError.<FilesUploadSessionFinishError>>
-
filesUploadSessionFinishBatch(arg)
-
This route helps you commit many files at once into a user's Dropbox. Use
upload_session/start and upload_session/append_v2 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_v2 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesUploadSessionFinishBatchLaunch>, DropboxResponseError.<void>>
-
filesUploadSessionFinishBatchCheck(arg)
-
Returns the status of an asynchronous job for upload_session/finish_batch. If
success, it returns list of result for each entry.
Route attributes:
scope: files.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesUploadSessionFinishBatchJobStatus>, DropboxResponseError.<AsyncPollError>>
-
filesUploadSessionFinishBatchV2(arg)
-
This route helps you commit many files at once into a user's Dropbox. Use
upload_session/start and upload_session/append_v2 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_v2 call of each
upload session. The maximum size of a file one can upload to an upload
session is 350 GB. 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesUploadSessionFinishBatchResult>, DropboxResponseError.<void>>
-
filesUploadSessionStart(arg)
-
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_v2 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 7 days. Attempting
to use an UploadSessionStartResult.session_id with upload_session/append_v2
or upload_session/finish more than 7 days 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
https://www.dropbox.com/developers/reference/data-transport-limit. By
default, upload sessions require you to send content of the file in
sequential order via consecutive upload_session/start,
upload_session/append_v2, upload_session/finish calls. For better
performance, you can instead optionally use a UploadSessionType.concurrent
upload session. To start a new concurrent session, set
UploadSessionStartArg.session_type to UploadSessionType.concurrent. After
that, you can send file data in concurrent upload_session/append_v2 requests.
Finally finish the session with upload_session/finish. There are couple of
constraints with concurrent sessions to make them work. You can not send data
with upload_session/start or upload_session/finish call, only with
upload_session/append_v2 call. Also data uploaded in upload_session/append_v2
call must be multiple of 4194304 bytes (except for last
upload_session/append_v2 with UploadSessionStartArg.close to true, that may
contain any remaining data).
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesUploadSessionStartResult>, DropboxResponseError.<FilesUploadSessionStartError>>
-
filesUploadSessionStartBatch(arg)
-
This route starts batch of upload_sessions. Please refer to
`upload_session/start` usage. 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<FilesUploadSessionStartBatchResult>, DropboxResponseError.<void>>
-
openidUserinfo(arg)
-
This route is used for refreshing the info that is found in the id_token
during the OIDC flow. This route doesn't require any arguments and will use
the scopes approved for the given access token.
Route attributes:
scope: openid
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<OpenidUserInfoResult>, DropboxResponseError.<OpenidUserInfoError>>
-
paperDocsArchive(arg)
-
Marks the given Paper doc as archived. This action can be performed or undone
by anyone with edit permissions to the doc. Note that this endpoint will
continue to work for content created by users on the older version of Paper.
To check which version of Paper a user is on, use /users/features/get_values.
If the paper_as_files feature is enabled, then the user is running the new
version of Paper. This endpoint will be retired in September 2020. Refer to
the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
more information.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsCreate(arg)
-
Creates a new Paper doc with the provided content. Note that this endpoint
will continue to work for content created by users on the older version of
Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. This endpoint will be retired
in September 2020. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
more information.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperPaperDocCreateUpdateResult>, DropboxResponseError.<PaperPaperDocCreateError>>
-
paperDocsDownload(arg)
-
Exports and downloads Paper doc either as HTML or markdown. Note that this
endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: files.content.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperPaperDocExportResult>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsFolderUsersList(arg)
-
Lists the users who are explicitly invited to the Paper folder in which the
Paper doc is contained. For private folders all users (including owner)
shared on the folder are listed and for team folders all non-team users
shared on the folder are returned. Note that this endpoint will continue to
work for content created by users on the older version of Paper. To check
which version of Paper a user is on, use /users/features/get_values. If the
paper_as_files feature is enabled, then the user is running the new version
of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperListUsersOnFolderResponse>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsFolderUsersListContinue(arg)
-
Once a cursor has been retrieved from docs/folder_users/list, use this to
paginate through all users on the Paper folder. Note that this endpoint will
continue to work for content created by users on the older version of Paper.
To check which version of Paper a user is on, use /users/features/get_values.
If the paper_as_files feature is enabled, then the user is running the new
version of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperListUsersOnFolderResponse>, DropboxResponseError.<PaperListUsersCursorError>>
-
paperDocsGetFolderInfo(arg)
-
Retrieves folder information for the given Paper doc. This includes: -
folder sharing policy; permissions for subfolders are set by the top-level
folder. - full 'filepath', i.e. the list of folders (both folderId and
folderName) from the root folder to the folder directly containing the
Paper doc. If the Paper doc is not in any folder (aka unfiled) the response
will be empty. Note that this endpoint will continue to work for content
created by users on the older version of Paper. To check which version of
Paper a user is on, use /users/features/get_values. If the paper_as_files
feature is enabled, then the user is running the new version of Paper. Refer
to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperFoldersContainingPaperDoc>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsList(arg)
-
Return the list of all Paper docs according to the argument specifications.
To iterate over through the full pagination, pass the cursor to
docs/list/continue. Note that this endpoint will continue to work for content
created by users on the older version of Paper. To check which version of
Paper a user is on, use /users/features/get_values. If the paper_as_files
feature is enabled, then the user is running the new version of Paper. Refer
to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: files.metadata.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperListPaperDocsResponse>, DropboxResponseError.<void>>
-
paperDocsListContinue(arg)
-
Once a cursor has been retrieved from docs/list, use this to paginate through
all Paper doc. Note that this endpoint will continue to work for content
created by users on the older version of Paper. To check which version of
Paper a user is on, use /users/features/get_values. If the paper_as_files
feature is enabled, then the user is running the new version of Paper. Refer
to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: files.metadata.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperListPaperDocsResponse>, DropboxResponseError.<PaperListDocsCursorError>>
-
paperDocsPermanentlyDelete(arg)
-
Permanently deletes the given Paper doc. This operation is final as the doc
cannot be recovered. This action can be performed only by the doc owner. Note
that this endpoint will continue to work for content created by users on the
older version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: files.permanent_delete
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsSharingPolicyGet(arg)
-
Gets the default sharing policy for the given Paper doc. Note that this
endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: sharing.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperSharingPolicy>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsSharingPolicySet(arg)
-
Sets the default sharing policy for the given Paper doc. The default
'team_sharing_policy' can be changed only by teams, omit this field for
personal accounts. The 'public_sharing_policy' policy can't be set to the
value 'disabled' because this setting can be changed only via the team admin
console. Note that this endpoint will continue to work for content created by
users on the older version of Paper. To check which version of Paper a user
is on, use /users/features/get_values. If the paper_as_files feature is
enabled, then the user is running the new version of Paper. Refer to the
Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsUpdate(arg)
-
Updates an existing Paper doc with the provided content. Note that this
endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. This endpoint will be retired
in September 2020. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
more information.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperPaperDocCreateUpdateResult>, DropboxResponseError.<PaperPaperDocUpdateError>>
-
paperDocsUsersAdd(arg)
-
Allows an owner or editor to add users to a Paper doc or change their
permissions using their email address or Dropbox account ID. The doc owner's
permissions cannot be changed. Note that this endpoint will continue to work
for content created by users on the older version of Paper. To check which
version of Paper a user is on, use /users/features/get_values. If the
paper_as_files feature is enabled, then the user is running the new version
of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<PaperAddPaperDocUserMemberResult>>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsUsersList(arg)
-
Lists all users who visited the Paper doc or users with explicit access. This
call excludes users who have been removed. The list is sorted by the date of
the visit or the share date. The list will include both users, the explicitly
shared ones as well as those who came in using the Paper url link. Note that
this endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: sharing.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperListUsersOnPaperDocResponse>, DropboxResponseError.<PaperDocLookupError>>
-
paperDocsUsersListContinue(arg)
-
Once a cursor has been retrieved from docs/users/list, use this to paginate
through all users on the Paper doc. Note that this endpoint will continue to
work for content created by users on the older version of Paper. To check
which version of Paper a user is on, use /users/features/get_values. If the
paper_as_files feature is enabled, then the user is running the new version
of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperListUsersOnPaperDocResponse>, DropboxResponseError.<PaperListUsersCursorError>>
-
paperDocsUsersRemove(arg)
-
Allows an owner or editor to remove users from a Paper doc using their email
address or Dropbox account ID. The doc owner cannot be removed. Note that
this endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: sharing.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<PaperDocLookupError>>
-
paperFoldersCreate(arg)
-
Create a new Paper folder with the provided info. Note that this endpoint
will continue to work for content created by users on the older version of
Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: files.content.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<PaperPaperFolderCreateResult>, DropboxResponseError.<PaperPaperFolderCreateError>>
-
sharingAddFileMember(arg)
-
Adds specified members to a file.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<SharingFileMemberActionResult>>, DropboxResponseError.<SharingAddFileMemberError>>
-
sharingAddFolderMember(arg)
-
Allows an owner or editor (if the ACL update policy allows) of a shared
folder to add another member. For the new member to get access to all the
functionality for this folder, you will need to call mount_folder on their
behalf.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<SharingAddFolderMemberError>>
-
sharingCheckJobStatus(arg)
-
Returns the status of an asynchronous job.
Route attributes:
scope: sharing.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingJobStatus>, DropboxResponseError.<AsyncPollError>>
-
sharingCheckRemoveMemberJobStatus(arg)
-
Returns the status of an asynchronous job for sharing a folder.
Route attributes:
scope: sharing.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingRemoveMemberJobStatus>, DropboxResponseError.<AsyncPollError>>
-
sharingCheckShareJobStatus(arg)
-
Returns the status of an asynchronous job for sharing a folder.
Route attributes:
scope: sharing.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingShareFolderJobStatus>, DropboxResponseError.<AsyncPollError>>
-
sharingCreateSharedLink(arg)
-
Create a shared link. If a shared link already exists for the given path,
that link is returned. Previously, it was technically possible to break a
shared link by moving or renaming the corresponding file or folder. In the
future, this will no longer be the case, so your app shouldn't rely on this
behavior. Instead, if your app needs to revoke a shared link, use
revoke_shared_link.
Route attributes:
scope: sharing.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingPathLinkMetadata>, DropboxResponseError.<SharingCreateSharedLinkError>>
-
sharingCreateSharedLinkWithSettings(arg)
-
Create a shared link with custom settings. If no settings are given then the
default visibility is RequestedVisibility.public (The resolved visibility,
though, may depend on other aspects such as team and shared folder settings).
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingCreateSharedLinkWithSettingsError>>
-
-
Returns shared file metadata.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFileMetadata>, DropboxResponseError.<SharingGetFileMetadataError>>
-
-
Returns shared file metadata.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<SharingGetFileMetadataBatchResult>>, DropboxResponseError.<SharingSharingUserError>>
-
-
Returns shared folder metadata by its folder ID.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFolderMetadata>, DropboxResponseError.<SharingSharedFolderAccessError>>
-
sharingGetSharedLinkFile(arg)
-
Download the shared link's file from a user's Dropbox.
Route attributes:
scope: sharing.read
Parameters:
| Name |
Type |
Description |
arg |
Object
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingGetSharedLinkFileError>>
-
-
Get the shared link's metadata.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingSharedLinkError>>
-
sharingGetSharedLinks(arg)
-
Returns a list of LinkMetadata objects for this user, including collection
links. If no path is given, returns a list of all shared links for the
current user, including collection links, up to a maximum of 1000 links. If a
non-empty path is given, returns a list of all shared links that allow access
to the given path. Collection links are never returned in this case.
Route attributes:
scope: sharing.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingGetSharedLinksResult>, DropboxResponseError.<SharingGetSharedLinksError>>
-
sharingListFileMembers(arg)
-
Use to obtain the members who have been invited to a file, both inherited and
uninherited members.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFileMembers>, DropboxResponseError.<SharingListFileMembersError>>
-
sharingListFileMembersBatch(arg)
-
Get members of multiple files at once. The arguments to this route are more
limited, and the limit on query result size per file is more strict. To
customize the results more, use the individual file endpoint. Inherited users
and groups are not included in the result, and permissions are not returned
for this endpoint.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<SharingListFileMembersBatchResult>>, DropboxResponseError.<SharingSharingUserError>>
-
sharingListFileMembersContinue(arg)
-
Once a cursor has been retrieved from list_file_members or
list_file_members/batch, use this to paginate through all shared file
members.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFileMembers>, DropboxResponseError.<SharingListFileMembersContinueError>>
-
sharingListFolderMembers(arg)
-
Returns shared folder membership by its folder ID.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFolderMembers>, DropboxResponseError.<SharingSharedFolderAccessError>>
-
sharingListFolderMembersContinue(arg)
-
Once a cursor has been retrieved from list_folder_members, use this to
paginate through all shared folder members.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFolderMembers>, DropboxResponseError.<SharingListFolderMembersContinueError>>
-
sharingListFolders(arg)
-
Return the list of all shared folders the current user has access to.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingListFoldersResult>, DropboxResponseError.<void>>
-
sharingListFoldersContinue(arg)
-
Once a cursor has been retrieved from list_folders, use this to paginate
through all shared folders. The cursor must come from a previous call to
list_folders or list_folders/continue.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingListFoldersResult>, DropboxResponseError.<SharingListFoldersContinueError>>
-
sharingListMountableFolders(arg)
-
Return the list of all shared folders the current user can mount or unmount.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingListFoldersResult>, DropboxResponseError.<void>>
-
sharingListMountableFoldersContinue(arg)
-
Once a cursor has been retrieved from list_mountable_folders, use this to
paginate through all mountable shared folders. The cursor must come from a
previous call to list_mountable_folders or list_mountable_folders/continue.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingListFoldersResult>, DropboxResponseError.<SharingListFoldersContinueError>>
-
sharingListReceivedFiles(arg)
-
Returns a list of all files shared with current user. Does not include files
the user has received via shared folders, and does not include unclaimed
invitations.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingListFilesResult>, DropboxResponseError.<SharingSharingUserError>>
-
sharingListReceivedFilesContinue(arg)
-
Get more results with a cursor from list_received_files.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingListFilesResult>, DropboxResponseError.<SharingListFilesContinueError>>
-
sharingListSharedLinks(arg)
-
List shared links of this user. If no path is given, returns a list of all
shared links for the current user. For members of business teams using team
space and member folders, returns all shared links in the team member's home
folder unless the team space ID is specified in the request header. For more
information, refer to the Namespace Guide
https://www.dropbox.com/developers/reference/namespace-guide. If a non-empty
path is given, returns a list of all shared links that allow access to the
given path - direct links to the given path and links to parent folders of
the given path. Links to parent folders can be suppressed by setting
direct_only to true.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingListSharedLinksResult>, DropboxResponseError.<SharingListSharedLinksError>>
-
sharingModifySharedLinkSettings(arg)
-
Modify the shared link's settings. If the requested visibility conflict with
the shared links policy of the team or the shared folder (in case the linked
file is part of a shared folder) then the LinkPermissions.resolved_visibility
of the returned SharedLinkMetadata will reflect the actual visibility of the
shared link and the LinkPermissions.requested_visibility will reflect the
requested visibility.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingModifySharedLinkSettingsError>>
-
sharingMountFolder(arg)
-
The current user mounts the designated folder. Mount a shared folder for a
user after they have been added as a member. Once mounted, the shared folder
will appear in their Dropbox.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFolderMetadata>, DropboxResponseError.<SharingMountFolderError>>
-
sharingRelinquishFileMembership(arg)
-
The current user relinquishes their membership in the designated file. Note
that the current user may still have inherited access to this file through
the parent folder.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<SharingRelinquishFileMembershipError>>
-
sharingRelinquishFolderMembership(arg)
-
The current user relinquishes their membership in the designated shared
folder and will no longer have access to the folder. A folder owner cannot
relinquish membership in their own folder. This will run synchronously if
leave_a_copy is false, and asynchronously if leave_a_copy is true.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncLaunchEmptyResult>, DropboxResponseError.<SharingRelinquishFolderMembershipError>>
-
sharingRemoveFileMember(arg)
-
Identical to remove_file_member_2 but with less information returned.
Route attributes:
scope: sharing.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingFileMemberActionIndividualResult>, DropboxResponseError.<SharingRemoveFileMemberError>>
-
sharingRemoveFileMember2(arg)
-
Removes a specified member from the file.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingFileMemberRemoveActionResult>, DropboxResponseError.<SharingRemoveFileMemberError>>
-
sharingRemoveFolderMember(arg)
-
Allows an owner or editor (if the ACL update policy allows) of a shared
folder to remove another member.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncLaunchResultBase>, DropboxResponseError.<SharingRemoveFolderMemberError>>
-
sharingRevokeSharedLink(arg)
-
Revoke a shared link. Note that even after revoking a shared link to a file,
the file may be accessible if there are shared links leading to any of the
file parent folders. To list all shared links that enable access to a
specific file, you can use the list_shared_links with the file as the
ListSharedLinksArg.path argument.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<SharingRevokeSharedLinkError>>
-
sharingSetAccessInheritance(arg)
-
Change the inheritance policy of an existing Shared Folder. Only permitted
for shared folders in a shared team root. If a ShareFolderLaunch.async_job_id
is returned, you'll need to call check_share_job_status until the action
completes to get the metadata for the folder.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingShareFolderLaunch>, DropboxResponseError.<SharingSetAccessInheritanceError>>
-
sharingShareFolder(arg)
-
Share a folder with collaborators. Most sharing will be completed
synchronously. Large folders will be completed asynchronously. To make
testing the async case repeatable, set `ShareFolderArg.force_async`. If a
ShareFolderLaunch.async_job_id is returned, you'll need to call
check_share_job_status until the action completes to get the metadata for the
folder.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingShareFolderLaunch>, DropboxResponseError.<SharingShareFolderError>>
-
sharingTransferFolder(arg)
-
Transfer ownership of a shared folder to a member of the shared folder. User
must have AccessLevel.owner access to the shared folder to perform a
transfer.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<SharingTransferFolderError>>
-
sharingUnmountFolder(arg)
-
The current user unmounts the designated folder. They can re-mount the folder
at a later time using mount_folder.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<SharingUnmountFolderError>>
-
sharingUnshareFile(arg)
-
Remove all members from this file. Does not remove inherited members.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<SharingUnshareFileError>>
-
sharingUnshareFolder(arg)
-
Allows a shared folder owner to unshare the folder. You'll need to call
check_job_status to determine if the action has completed successfully.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncLaunchEmptyResult>, DropboxResponseError.<SharingUnshareFolderError>>
-
sharingUpdateFileMember(arg)
-
Changes a member's access on a shared file.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingMemberAccessLevelResult>, DropboxResponseError.<SharingFileMemberActionError>>
-
sharingUpdateFolderMember(arg)
-
Allows an owner or editor of a shared folder to update another member's
permissions.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingMemberAccessLevelResult>, DropboxResponseError.<SharingUpdateFolderMemberError>>
-
sharingUpdateFolderPolicy(arg)
-
Update the sharing policies for a shared folder. User must have
AccessLevel.owner access to the shared folder to update its policies.
Route attributes:
scope: sharing.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<SharingSharedFolderMetadata>, DropboxResponseError.<SharingUpdateFolderPolicyError>>
-
teamDevicesListMemberDevices(arg)
-
List all device sessions of a team's member.
Route attributes:
scope: sessions.list
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamListMemberDevicesResult>, DropboxResponseError.<TeamListMemberDevicesError>>
-
teamDevicesListMembersDevices(arg)
-
List all device sessions of a team. Permission : Team member file access.
Route attributes:
scope: sessions.list
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamListMembersDevicesResult>, DropboxResponseError.<TeamListMembersDevicesError>>
-
teamDevicesListTeamDevices(arg)
-
List all device sessions of a team. Permission : Team member file access.
Route attributes:
scope: sessions.list
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamListTeamDevicesResult>, DropboxResponseError.<TeamListTeamDevicesError>>
-
teamDevicesRevokeDeviceSession(arg)
-
Revoke a device session of a team's member.
Route attributes:
scope: sessions.modify
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamRevokeDeviceSessionError>>
-
teamDevicesRevokeDeviceSessionBatch(arg)
-
Revoke a list of device sessions of team members.
Route attributes:
scope: sessions.modify
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamRevokeDeviceSessionBatchResult>, DropboxResponseError.<TeamRevokeDeviceSessionBatchError>>
-
teamFeaturesGetValues(arg)
-
Get the values for one or more featues. This route allows you to check your
account's capability for what feature you can access or what value you have
for certain features. Permission : Team information.
Route attributes:
scope: team_info.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamFeaturesGetValuesBatchResult>, DropboxResponseError.<TeamFeaturesGetValuesBatchError>>
-
teamGetInfo()
-
Retrieves information about a team.
Route attributes:
scope: team_info.read
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamGetInfoResult>, DropboxResponseError.<void>>
-
teamGroupsCreate(arg)
-
Creates a new, empty group, with a requested name. Permission : Team member
management.
Route attributes:
scope: groups.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupFullInfo>, DropboxResponseError.<TeamGroupCreateError>>
-
teamGroupsDelete(arg)
-
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.
Route attributes:
scope: groups.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncLaunchEmptyResult>, DropboxResponseError.<TeamGroupDeleteError>>
-
teamGroupsGetInfo(arg)
-
Retrieves information about one or more groups. Note that the optional field
GroupFullInfo.members is not returned for system-managed groups. Permission :
Team Information.
Route attributes:
scope: groups.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Object>, DropboxResponseError.<TeamGroupsGetInfoError>>
-
teamGroupsJobStatusGet(arg)
-
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.
Route attributes:
scope: groups.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncPollEmptyResult>, DropboxResponseError.<TeamGroupsPollError>>
-
teamGroupsList(arg)
-
Lists groups on a team. Permission : Team Information.
Route attributes:
scope: groups.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupsListResult>, DropboxResponseError.<void>>
-
teamGroupsListContinue(arg)
-
Once a cursor has been retrieved from groups/list, use this to paginate
through all groups. Permission : Team Information.
Route attributes:
scope: groups.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupsListResult>, DropboxResponseError.<TeamGroupsListContinueError>>
-
teamGroupsMembersAdd(arg)
-
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.
Route attributes:
scope: groups.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupMembersChangeResult>, DropboxResponseError.<TeamGroupMembersAddError>>
-
teamGroupsMembersList(arg)
-
Lists members of a group. Permission : Team Information.
Route attributes:
scope: groups.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupsMembersListResult>, DropboxResponseError.<TeamGroupSelectorError>>
-
teamGroupsMembersListContinue(arg)
-
Once a cursor has been retrieved from groups/members/list, use this to
paginate through all members of the group. Permission : Team information.
Route attributes:
scope: groups.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupsMembersListResult>, DropboxResponseError.<TeamGroupsMembersListContinueError>>
-
teamGroupsMembersRemove(arg)
-
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.
Route attributes:
scope: groups.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupMembersChangeResult>, DropboxResponseError.<TeamGroupMembersRemoveError>>
-
-
Sets a member's access type in a group. Permission : Team member management.
Route attributes:
scope: groups.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Object>, DropboxResponseError.<TeamGroupMemberSetAccessTypeError>>
-
teamGroupsUpdate(arg)
-
Updates a group's name and/or external ID. Permission : Team member
management.
Route attributes:
scope: groups.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGroupFullInfo>, DropboxResponseError.<TeamGroupUpdateError>>
-
teamLegalHoldsCreatePolicy(arg)
-
Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all
teams have the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Object>, DropboxResponseError.<TeamLegalHoldsPolicyCreateError>>
-
teamLegalHoldsGetPolicy(arg)
-
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.
Route attributes:
scope: team_data.governance.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Object>, DropboxResponseError.<TeamLegalHoldsGetPolicyError>>
-
teamLegalHoldsListHeldRevisions(arg)
-
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.
Route attributes:
scope: team_data.governance.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamLegalHoldsListHeldRevisionResult>, DropboxResponseError.<TeamLegalHoldsListHeldRevisionsError>>
-
teamLegalHoldsListHeldRevisionsContinue(arg)
-
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.
Route attributes:
scope: team_data.governance.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamLegalHoldsListHeldRevisionResult>, DropboxResponseError.<TeamLegalHoldsListHeldRevisionsError>>
-
teamLegalHoldsListPolicies(arg)
-
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.
Route attributes:
scope: team_data.governance.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamLegalHoldsListPoliciesResult>, DropboxResponseError.<TeamLegalHoldsListPoliciesError>>
-
teamLegalHoldsReleasePolicy(arg)
-
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.
Route attributes:
scope: team_data.governance.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamLegalHoldsPolicyReleaseError>>
-
teamLegalHoldsUpdatePolicy(arg)
-
Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have
the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Object>, DropboxResponseError.<TeamLegalHoldsPolicyUpdateError>>
-
teamLinkedAppsListMemberLinkedApps(arg)
-
List all linked applications of the team member. Note, this endpoint does not
list any team-linked applications.
Route attributes:
scope: sessions.list
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamListMemberAppsResult>, DropboxResponseError.<TeamListMemberAppsError>>
-
teamLinkedAppsListMembersLinkedApps(arg)
-
List all applications linked to the team members' accounts. Note, this
endpoint does not list any team-linked applications.
Route attributes:
scope: sessions.list
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamListMembersAppsResult>, DropboxResponseError.<TeamListMembersAppsError>>
-
teamLinkedAppsListTeamLinkedApps(arg)
-
List all applications linked to the team members' accounts. Note, this
endpoint doesn't list any team-linked applications.
Route attributes:
scope: sessions.list
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamListTeamAppsResult>, DropboxResponseError.<TeamListTeamAppsError>>
-
teamLinkedAppsRevokeLinkedApp(arg)
-
Revoke a linked application of the team member.
Route attributes:
scope: sessions.modify
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamRevokeLinkedAppError>>
-
teamLinkedAppsRevokeLinkedAppBatch(arg)
-
Revoke a list of linked applications of the team members.
Route attributes:
scope: sessions.modify
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamRevokeLinkedAppBatchResult>, DropboxResponseError.<TeamRevokeLinkedAppBatchError>>
-
teamLogGetEvents(arg)
-
Retrieves team events. If the result's GetTeamEventsResult.has_more field is
true, call get_events/continue with the returned cursor to retrieve more
entries. If end_time is not specified in your request, you may use the
returned cursor to poll get_events/continue for new events. Many attributes
note 'may be missing due to historical data gap'. Note that the
file_operations category and & analogous paper events are not available on
all Dropbox Business plans /business/plans-comparison. Use
features/get_values
/developers/documentation/http/teams#team-features-get_values to check for
this feature. Permission : Team Auditing.
Route attributes:
scope: events.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamLogGetTeamEventsResult>, DropboxResponseError.<TeamLogGetTeamEventsError>>
-
teamLogGetEventsContinue(arg)
-
Once a cursor has been retrieved from get_events, use this to paginate
through all events. Permission : Team Auditing.
Route attributes:
scope: events.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamLogGetTeamEventsResult>, DropboxResponseError.<TeamLogGetTeamEventsContinueError>>
-
teamMembersAdd(arg)
-
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'.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersAddLaunch>, DropboxResponseError.<void>>
-
teamMembersAddJobStatusGet(arg)
-
Once an async_job_id is returned from members/add , use this to poll the
status of the asynchronous request. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersAddJobStatus>, DropboxResponseError.<AsyncPollError>>
-
teamMembersAddJobStatusGetV2(arg)
-
Once an async_job_id is returned from members/add_v2 , use this to poll the
status of the asynchronous request. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersAddJobStatusV2Result>, DropboxResponseError.<AsyncPollError>>
-
teamMembersAddV2(arg)
-
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'.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersAddLaunchV2Result>, DropboxResponseError.<void>>
-
teamMembersDeleteProfilePhoto(arg)
-
Deletes a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamMemberInfo>, DropboxResponseError.<TeamMembersDeleteProfilePhotoError>>
-
teamMembersDeleteProfilePhotoV2(arg)
-
Deletes a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamMemberInfoV2Result>, DropboxResponseError.<TeamMembersDeleteProfilePhotoError>>
-
teamMembersGetAvailableTeamMemberRoles()
-
Get available TeamMemberRoles for the connected team. To be used with
members/set_admin_permissions_v2. Permission : Team member management.
Route attributes:
scope: members.read
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersGetAvailableTeamMemberRolesResult>, DropboxResponseError.<void>>
-
teamMembersGetInfo(arg)
-
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.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Object>, DropboxResponseError.<TeamMembersGetInfoError>>
-
teamMembersGetInfoV2(arg)
-
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.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersGetInfoV2Result>, DropboxResponseError.<TeamMembersGetInfoError>>
-
teamMembersList(arg)
-
Lists members of a team. Permission : Team information.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersListResult>, DropboxResponseError.<TeamMembersListError>>
-
teamMembersListContinue(arg)
-
Once a cursor has been retrieved from members/list, use this to paginate
through all team members. Permission : Team information.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersListResult>, DropboxResponseError.<TeamMembersListContinueError>>
-
teamMembersListContinueV2(arg)
-
Once a cursor has been retrieved from members/list_v2, use this to paginate
through all team members. Permission : Team information.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersListV2Result>, DropboxResponseError.<TeamMembersListContinueError>>
-
teamMembersListV2(arg)
-
Lists members of a team. Permission : Team information.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersListV2Result>, DropboxResponseError.<TeamMembersListError>>
-
-
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.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncLaunchEmptyResult>, DropboxResponseError.<TeamMembersTransferFormerMembersFilesError>>
-
-
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.
Route attributes:
scope: members.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncPollEmptyResult>, DropboxResponseError.<AsyncPollError>>
-
teamMemberSpaceLimitsExcludedUsersAdd(arg)
-
Add users to member space limits excluded users list.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamExcludedUsersUpdateResult>, DropboxResponseError.<TeamExcludedUsersUpdateError>>
-
teamMemberSpaceLimitsExcludedUsersList(arg)
-
List member space limits excluded users.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamExcludedUsersListResult>, DropboxResponseError.<TeamExcludedUsersListError>>
-
teamMemberSpaceLimitsExcludedUsersListContinue(arg)
-
Continue listing member space limits excluded users.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamExcludedUsersListResult>, DropboxResponseError.<TeamExcludedUsersListContinueError>>
-
teamMemberSpaceLimitsExcludedUsersRemove(arg)
-
Remove users from member space limits excluded users list.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamExcludedUsersUpdateResult>, DropboxResponseError.<TeamExcludedUsersUpdateError>>
-
teamMemberSpaceLimitsGetCustomQuota(arg)
-
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.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<TeamCustomQuotaResult>>, DropboxResponseError.<TeamCustomQuotaError>>
-
teamMemberSpaceLimitsRemoveCustomQuota(arg)
-
Remove users custom quota. A maximum of 1000 members can be specified in a
single call.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<TeamRemoveCustomQuotaResult>>, DropboxResponseError.<TeamCustomQuotaError>>
-
teamMemberSpaceLimitsSetCustomQuota(arg)
-
Set users custom quota. Custom quota has to be at least 15GB. A maximum of
1000 members can be specified in a single call.
Route attributes:
scope: members.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<TeamCustomQuotaResult>>, DropboxResponseError.<TeamSetCustomQuotaError>>
-
teamMembersRecover(arg)
-
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.
Route attributes:
scope: members.delete
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamMembersRecoverError>>
-
teamMembersRemove(arg)
-
Removes a member from a team. Permission : Team member management Exactly one
of team_member_id, email, or external_id must be provided to identify the
user account. Accounts can be recovered via members/recover for a 7 day
period or until the account has been permanently deleted or transferred to
another account (whichever comes first). Calling members/add while a user is
still recoverable on your team will return with
MemberAddResult.user_already_on_team. Accounts can have their files
transferred via the admin console for a limited time, based on the version
history length associated with the team (180 days for most teams). This
endpoint may initiate an asynchronous job. To obtain the final result of the
job, the client should periodically poll members/remove/job_status/get.
Route attributes:
scope: members.delete
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncLaunchEmptyResult>, DropboxResponseError.<TeamMembersRemoveError>>
-
teamMembersRemoveJobStatusGet(arg)
-
Once an async_job_id is returned from members/remove , use this to poll the
status of the asynchronous request. Permission : Team member management.
Route attributes:
scope: members.delete
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<AsyncPollEmptyResult>, DropboxResponseError.<AsyncPollError>>
-
-
Add secondary emails to users. Permission : Team member management. Emails
that are on verified domains will be verified automatically. For each email
address not on a verified domain a verification email will be sent.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamAddSecondaryEmailsResult>, DropboxResponseError.<TeamAddSecondaryEmailsError>>
-
-
Delete secondary emails from users Permission : Team member management. Users
will be notified of deletions of verified secondary emails at both the
secondary email and their primary email.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamDeleteSecondaryEmailsResult>, DropboxResponseError.<void>>
-
-
Resend secondary email verification emails. Permission : Team member
management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamResendVerificationEmailResult>, DropboxResponseError.<void>>
-
-
Sends welcome email to pending team member. Permission : Team member
management Exactly one of team_member_id, email, or external_id must be
provided to identify the user account. No-op if team member is not pending.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamMembersSendWelcomeError>>
-
-
Updates a team member's permissions. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersSetPermissionsResult>, DropboxResponseError.<TeamMembersSetPermissionsError>>
-
-
Updates a team member's permissions. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamMembersSetPermissions2Result>, DropboxResponseError.<TeamMembersSetPermissions2Error>>
-
-
Updates a team member's profile. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamMemberInfo>, DropboxResponseError.<TeamMembersSetProfileError>>
-
-
Updates a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamMemberInfo>, DropboxResponseError.<TeamMembersSetProfilePhotoError>>
-
-
Updates a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamMemberInfoV2Result>, DropboxResponseError.<TeamMembersSetProfilePhotoError>>
-
-
Updates a team member's profile. Permission : Team member management.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamMemberInfoV2Result>, DropboxResponseError.<TeamMembersSetProfileError>>
-
-
Suspend a member from a team. Permission : Team member management Exactly one
of team_member_id, email, or external_id must be provided to identify the
user account.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamMembersSuspendError>>
-
teamMembersUnsuspend(arg)
-
Unsuspend a member from a team. Permission : Team member management Exactly
one of team_member_id, email, or external_id must be provided to identify the
user account.
Route attributes:
scope: members.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamMembersUnsuspendError>>
-
teamNamespacesList(arg)
-
Returns a list of all team-accessible namespaces. This list includes team
folders, shared folders containing team members, team members' home
namespaces, and team members' app folders. Home namespaces and app folders
are always owned by this team or members of the team, but shared folders may
be owned by other users or other teams. Duplicates may occur in the list.
Route attributes:
scope: team_data.member
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamNamespacesListResult>, DropboxResponseError.<TeamTeamNamespacesListError>>
-
teamNamespacesListContinue(arg)
-
Once a cursor has been retrieved from namespaces/list, use this to paginate
through all team-accessible namespaces. Duplicates may occur in the list.
Route attributes:
scope: team_data.member
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamNamespacesListResult>, DropboxResponseError.<TeamTeamNamespacesListContinueError>>
-
teamPropertiesTemplateAdd(arg)
-
Permission : Team member file access.
Route attributes:
scope: files.team_metadata.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesAddTemplateResult>, DropboxResponseError.<FilePropertiesModifyTemplateError>>
-
teamPropertiesTemplateGet(arg)
-
Permission : Team member file access. The scope for the route is
files.team_metadata.write.
Route attributes:
scope: files.team_metadata.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesGetTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
teamPropertiesTemplateList()
-
Permission : Team member file access. The scope for the route is
files.team_metadata.write.
Route attributes:
scope: files.team_metadata.write
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesListTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>
-
teamPropertiesTemplateUpdate(arg)
-
Permission : Team member file access.
Route attributes:
scope: files.team_metadata.write
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<FilePropertiesUpdateTemplateResult>, DropboxResponseError.<FilePropertiesModifyTemplateError>>
-
teamReportsGetActivity(arg)
-
Retrieves reporting data about a team's user activity. Deprecated: Will be
removed on July 1st 2021.
Route attributes:
scope: team_info.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGetActivityReport>, DropboxResponseError.<TeamDateRangeError>>
-
teamReportsGetDevices(arg)
-
Retrieves reporting data about a team's linked devices. Deprecated: Will be
removed on July 1st 2021.
Route attributes:
scope: team_info.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGetDevicesReport>, DropboxResponseError.<TeamDateRangeError>>
-
teamReportsGetMembership(arg)
-
Retrieves reporting data about a team's membership. Deprecated: Will be
removed on July 1st 2021.
Route attributes:
scope: team_info.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGetMembershipReport>, DropboxResponseError.<TeamDateRangeError>>
-
teamReportsGetStorage(arg)
-
Retrieves reporting data about a team's storage usage. Deprecated: Will be
removed on July 1st 2021.
Route attributes:
scope: team_info.read
Parameters:
- Deprecated:
-
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamGetStorageReport>, DropboxResponseError.<TeamDateRangeError>>
-
teamSharingAllowlistAdd(arg)
-
Endpoint adds Approve List entries. Changes are effective immediately.
Changes are committed in transaction. In case of single validation error -
all entries are rejected. Valid domains (RFC-1034/5) and emails
(RFC-5322/822) are accepted. Added entries cannot overflow limit of 10000
entries per team. Maximum 100 entries per call is allowed.
Route attributes:
scope: team_info.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamSharingAllowlistAddResponse>, DropboxResponseError.<TeamSharingAllowlistAddError>>
-
teamSharingAllowlistList(arg)
-
Lists Approve List entries for given team, from newest to oldest, returning
up to `limit` entries at a time. If there are more than `limit` entries
associated with the current team, more can be fetched by passing the returned
`cursor` to sharing_allowlist/list/continue.
Route attributes:
scope: team_info.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamSharingAllowlistListResponse>, DropboxResponseError.<TeamSharingAllowlistListError>>
-
teamSharingAllowlistListContinue(arg)
-
Lists entries associated with given team, starting from a the cursor. See
sharing_allowlist/list.
Route attributes:
scope: team_info.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamSharingAllowlistListResponse>, DropboxResponseError.<TeamSharingAllowlistListContinueError>>
-
teamSharingAllowlistRemove(arg)
-
Endpoint removes Approve List entries. Changes are effective immediately.
Changes are committed in transaction. In case of single validation error -
all entries are rejected. Valid domains (RFC-1034/5) and emails
(RFC-5322/822) are accepted. Entries being removed have to be present on the
list. Maximum 1000 entries per call is allowed.
Route attributes:
scope: team_info.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamSharingAllowlistRemoveResponse>, DropboxResponseError.<TeamSharingAllowlistRemoveError>>
-
teamTeamFolderActivate(arg)
-
Sets an archived team folder's status to active. Permission : Team member
file access.
Route attributes:
scope: team_data.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderActivateError>>
-
teamTeamFolderArchive(arg)
-
Sets an active team folder's status to archived and removes all folder and
file members. This endpoint cannot be used for teams that have a shared team
space. Permission : Team member file access.
Route attributes:
scope: team_data.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderArchiveLaunch>, DropboxResponseError.<TeamTeamFolderArchiveError>>
-
teamTeamFolderArchiveCheck(arg)
-
Returns the status of an asynchronous job for archiving a team folder.
Permission : Team member file access.
Route attributes:
scope: team_data.content.write
Parameters:
| Name |
Type |
Description |
arg |
AsyncPollArg
|
The request parameters. |
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderArchiveJobStatus>, DropboxResponseError.<AsyncPollError>>
-
teamTeamFolderCreate(arg)
-
Creates a new, active, team folder with no members. This endpoint can only be
used for teams that do not already have a shared team space. Permission :
Team member file access.
Route attributes:
scope: team_data.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderCreateError>>
-
teamTeamFolderGetInfo(arg)
-
Retrieves metadata for team folders. Permission : Team member file access.
Route attributes:
scope: team_data.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Array.<TeamTeamFolderGetInfoItem>>, DropboxResponseError.<void>>
-
teamTeamFolderList(arg)
-
Lists all team folders. Permission : Team member file access.
Route attributes:
scope: team_data.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderListResult>, DropboxResponseError.<TeamTeamFolderListError>>
-
teamTeamFolderListContinue(arg)
-
Once a cursor has been retrieved from team_folder/list, use this to paginate
through all team folders. Permission : Team member file access.
Route attributes:
scope: team_data.content.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderListResult>, DropboxResponseError.<TeamTeamFolderListContinueError>>
-
teamTeamFolderPermanentlyDelete(arg)
-
Permanently deletes an archived team folder. This endpoint cannot be used for
teams that have a shared team space. Permission : Team member file access.
Route attributes:
scope: team_data.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<void>, DropboxResponseError.<TeamTeamFolderPermanentlyDeleteError>>
-
teamTeamFolderRename(arg)
-
Changes an active team folder's name. Permission : Team member file access.
Route attributes:
scope: team_data.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderRenameError>>
-
teamTeamFolderUpdateSyncSettings(arg)
-
Updates the sync settings on a team folder or its contents. Use of this
endpoint requires that the team has team selective sync enabled.
Route attributes:
scope: team_data.content.write
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderUpdateSyncSettingsError>>
-
teamTokenGetAuthenticatedAdmin()
-
Returns the member profile of the admin who generated the team access token
used to make the call.
Route attributes:
scope: team_info.read
Returns:
-
Type
-
Promise.<DropboxResponse.<TeamTokenGetAuthenticatedAdminResult>, DropboxResponseError.<TeamTokenGetAuthenticatedAdminError>>
-
usersFeaturesGetValues(arg)
-
Get a list of feature values that may be configured for the current account.
Route attributes:
scope: account_info.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<UsersUserFeaturesGetValuesBatchResult>, DropboxResponseError.<UsersUserFeaturesGetValuesBatchError>>
-
usersGetAccount(arg)
-
Get information about a user's account.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<UsersBasicAccount>, DropboxResponseError.<UsersGetAccountError>>
-
usersGetAccountBatch(arg)
-
Get information about multiple user accounts. At most 300 accounts may be
queried per request.
Route attributes:
scope: sharing.read
Parameters:
Returns:
-
Type
-
Promise.<DropboxResponse.<Object>, DropboxResponseError.<UsersGetAccountBatchError>>
-
usersGetCurrentAccount()
-
Get information about the current user's account.
Route attributes:
scope: account_info.read
Returns:
-
Type
-
Promise.<DropboxResponse.<UsersFullAccount>, DropboxResponseError.<void>>
-
usersGetSpaceUsage()
-
Get the space usage information for the current user's account.
Route attributes:
scope: account_info.read
Returns:
-
Type
-
Promise.<DropboxResponse.<UsersSpaceUsage>, DropboxResponseError.<void>>