Dropbox Node SDK

Global

Methods

checkAndRefreshAccessToken()

Checks if a token is needed, can be refreshed and if the token is expired. If so, attempts to refresh access token
Returns:
Type
Promise.<*>

getAccessToken()

Get the access token
Returns:
Access token
Type
String

getAccessTokenExpiresAt()

Gets the access token's expiration date
Returns:
date of token expiration
Type
Date

getAccessTokenFromCode(redirectUri, code)

Get an OAuth2 access token from an OAuth2 Code.
Parameters:
Name Type Description
redirectUri String A URL to redirect the user to after authenticating. This must be added to your app through the admin interface.
code String An OAuth2 code.
Returns:
An object containing the token and related info (if applicable)
Type
Object

getAuthenticationUrl(redirectUri [, state] [, authType] [, tokenAccessType] [, scope] [, includeGrantedScopes] [, usePKCE])

Get a URL that can be used to authenticate users for the Dropbox API.
Parameters:
Name Type Argument Default Description
redirectUri String A URL to redirect the user to after authenticating. This must be added to your app through the admin interface.
state String <optional>
 State that will be returned in the redirect URL to help prevent cross site scripting attacks.
authType String <optional>
 token auth type, defaults to 'token', other option is 'code'
tokenAccessType String <optional>
 null type of token to request. From the following: null - creates a token with the app default (either legacy or online) legacy - creates one long-lived token with no expiration online - create one short-lived token with an expiration offline - create one short-lived token with an expiration with a refresh token
scope Array.<String> <optional>
 null scopes to request for the grant
includeGrantedScopes String <optional>
 none whether or not to include previously granted scopes. From the following: user - include user scopes in the grant team - include team scopes in the grant Note: if this user has never linked the app, include_granted_scopes must be None
usePKCE boolean <optional>
 false Whether or not to use Sha256 based PKCE. PKCE should be only use on client apps which doesn't call your server. It is less secure than non-PKCE flow but can be used if you are unable to safely retrieve your app secret
Returns:
- Url to send user to for Dropbox API authentication returned in a promise
Type
Promise.<String>

getClientId()

Get the client id
Returns:
Client id
Type
String

getClientSecret()

Get the client secret
Returns:
Client secret
Type
String

getCodeVerifier()

Gets the code verifier for PKCE flow
Returns:
- code verifier for PKCE
Type
String

getRefreshToken()

Gets the refresh token
Returns:
Refresh token
Type
String

refreshAccessToken(scope)

Refreshes the access token using the refresh token, if available
Parameters:
Name Type Default Description
scope Array.<String> null a subset of scopes from the original refresh to acquire with an access token
Returns:
Type
Promise.<*>

setAccessToken(accessToken)

Set the access token used to authenticate requests to the API.
Parameters:
Name Type Description
accessToken String An access token
Returns:
Type
undefined

setAccessTokenExpiresAt(accessTokenExpiresAt)

Sets the access token's expiration date
Parameters:
Name Type Description
accessTokenExpiresAt new expiration date

setClientId(clientId)

Set the client id, which is used to help gain an access token.
Parameters:
Name Type Description
clientId String Your apps client id
Returns:
Type
undefined

setClientSecret(clientSecret)

Set the client secret
Parameters:
Name Type Description
clientSecret String Your app's client secret
Returns:
Type
undefined

setCodeVerifier(codeVerifier)

Sets the code verifier for PKCE flow
Parameters:
Name Type Description
codeVerifier String new code verifier

setRefreshToken(refreshToken)

Sets the refresh token
Parameters:
Name Type Description
refreshToken A refresh token

Type Definitions

AccountPhotoSourceArg

Type:
  • Object
Properties:
Name Type Argument Description
base64_data string <optional>
 Available if .tag is base64_data. Image data in base64-encoded bytes.
.tag 'base64_data' | 'other' Tag identifying the union variant.

AccountSetProfilePhotoArg

Type:
  • Object
Properties:
Name Type Description
photo AccountPhotoSourceArg Image to set as the user's new profile photo.

AccountSetProfilePhotoError

Type:
  • Object
Properties:
Name Type Description
.tag 'file_type_error' | 'file_size_error' | 'dimension_error' | 'thumbnail_error' | 'transient_error' | 'other' Tag identifying the union variant.

AccountSetProfilePhotoResult

Type:
  • Object
Properties:
Name Type Description
profile_photo_url string URL for the photo representing the user, if one is set.

AsyncLaunchEmptyResult

Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

AsyncLaunchResultBase

Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
.tag 'async_job_id' Tag identifying the union variant.

AsyncPollArg

Arguments for methods that poll the status of an asynchronous job.
Type:
  • Object
Properties:
Name Type Description
async_job_id string Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

AsyncPollEmptyResult

Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.
Type:
  • Object
Properties:
Name Type Description
.tag 'in_progress' | 'complete' Tag identifying the union variant.

AsyncPollError

Error returned by methods for polling the status of asynchronous job.
Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_async_job_id' | 'internal_error' | 'other' Tag identifying the union variant.

AsyncPollResultBase

Result returned by methods that poll for the status of an asynchronous job. Unions that extend this union should add a 'complete' field with a type of the information returned upon job completion. See PollEmptyResult for an example.
Type:
  • Object
Properties:
Name Type Description
.tag 'in_progress' Tag identifying the union variant.

AuthAccessError

Error occurred because the account doesn't have permission to access the resource.
Type:
  • Object
Properties:
Name Type Argument Description
invalid_account_type AuthInvalidAccountTypeError <optional>
 Available if .tag is invalid_account_type. Current account type cannot access the resource.
paper_access_denied AuthPaperAccessError <optional>
 Available if .tag is paper_access_denied. Current account cannot access Paper.
.tag 'invalid_account_type' | 'paper_access_denied' | 'other' Tag identifying the union variant.

AuthAuthError

Errors occurred during authentication.
Type:
  • Object
Properties:
Name Type Argument Description
missing_scope AuthTokenScopeError <optional>
 Available if .tag is missing_scope. The access token does not have the required scope to access the route.
.tag 'invalid_access_token' | 'invalid_select_user' | 'invalid_select_admin' | 'user_suspended' | 'expired_access_token' | 'missing_scope' | 'route_access_denied' | 'other' Tag identifying the union variant.

AuthInvalidAccountTypeError

Type:
  • Object
Properties:
Name Type Description
.tag 'endpoint' | 'feature' | 'other' Tag identifying the union variant.

AuthPaperAccessError

Type:
  • Object
Properties:
Name Type Description
.tag 'paper_disabled' | 'not_paper_user' | 'other' Tag identifying the union variant.

AuthRateLimitError

Error occurred because the app is being rate limited.
Type:
  • Object
Properties:
Name Type Description
reason AuthRateLimitReason The reason why the app is being rate limited.
retry_after number The number of seconds that the app should wait before making another request.

AuthRateLimitReason

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_requests' | 'too_many_write_operations' | 'other' Tag identifying the union variant.

AuthTokenFromOAuth1Arg

Type:
  • Object
Properties:
Name Type Description
oauth1_token string The supplied OAuth 1.0 access token.
oauth1_token_secret string The token secret associated with the supplied access token.

AuthTokenFromOAuth1Error

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_oauth1_token_info' | 'app_id_mismatch' | 'other' Tag identifying the union variant.

AuthTokenFromOAuth1Result

Type:
  • Object
Properties:
Name Type Description
oauth2_token string The OAuth 2.0 token generated from the supplied OAuth 1.0 token.

AuthTokenScopeError

Type:
  • Object
Properties:
Name Type Description
required_scope string The required scope to access the route.

CheckEchoArg

EchoArg contains the arguments to be sent to the Dropbox servers.
Type:
  • Object
Properties:
Name Type Description
query string The string that you'd like to be echoed back to you.

CheckEchoResult

EchoResult contains the result returned from the Dropbox servers.
Type:
  • Object
Properties:
Name Type Description
result string If everything worked correctly, this would be the same as query.

CommonPathRoot

Type:
  • Object
Properties:
Name Type Argument Description
root string <optional>
 Available if .tag is root. Paths are relative to the authenticating user's root namespace (This results in :field:`PathRootError.invalid_root` if the user's root namespace has changed.).
namespace_id string <optional>
 Available if .tag is namespace_id. Paths are relative to given namespace id (This results in :field:`PathRootError.no_permission` if you don't have access to this namespace.).
.tag 'home' | 'root' | 'namespace_id' | 'other' Tag identifying the union variant.

CommonPathRootError

Type:
  • Object
Properties:
Name Type Argument Description
invalid_root CommonTeamRootInfo | CommonUserRootInfo | CommonRootInfo <optional>
 Available if .tag is invalid_root. The root namespace id in Dropbox-API-Path-Root header is not valid. The value of this error is the user's latest root info.
.tag 'invalid_root' | 'no_permission' | 'other' Tag identifying the union variant.

CommonRootInfo

Information about current user's root.
Type:
  • Object
Properties:
Name Type Description
.tag "team" | "user" Tag identifying the subtype variant.
root_namespace_id string The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as RootInfo.home_namespace_id.
home_namespace_id string The namespace ID for user's home namespace.

CommonTeamRootInfo

Root info when user is member of a team with a separate root namespace ID.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'team' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
root_namespace_id string The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as RootInfo.home_namespace_id.
home_namespace_id string The namespace ID for user's home namespace.
home_path string The path for user's home directory under the shared team root.

CommonUserRootInfo

Root info when user is not member of a team or the user is a member of a team and the team does not have a separate root namespace.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'user' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
root_namespace_id string The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as RootInfo.home_namespace_id.
home_namespace_id string The namespace ID for user's home namespace.

ContactsDeleteManualContactsArg

Type:
  • Object
Properties:
Name Type Description
email_addresses Array.<Object> List of manually added contacts to be deleted.

ContactsDeleteManualContactsError

Type:
  • Object
Properties:
Name Type Argument Description
contacts_not_found Array.<Object> <optional>
 Available if .tag is contacts_not_found. Can't delete contacts from this list. Make sure the list only has manually added contacts. The deletion was cancelled.
.tag 'contacts_not_found' | 'other' Tag identifying the union variant.

Error

An Error object returned from a route.
Type:
  • Object
Properties:
Name Type Description
error_summary string Text summary of the error.
error T The error object.
user_message UserMessage An optional field. If present, it includes a message that can be shown directly to the end user of your app. You should show this message if your app is unprepared to programmatically handle the error returned by an endpoint.

FilePropertiesAddPropertiesArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
property_groups Array.<FilePropertiesPropertyGroup> The property groups which are to be added to a Dropbox file. No two groups in the input should refer to the same template.

FilePropertiesAddPropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_field_too_large' | 'does_not_fit_template' | 'duplicate_property_groups' | 'property_group_already_exists' Tag identifying the union variant.

FilePropertiesAddTemplateArg

Type:
  • Object
Properties:
Name Type Description
name string Display name for the template. Template names can be up to 256 bytes.
description string Description for the template. Template descriptions can be up to 1024 bytes.
fields Array.<FilePropertiesPropertyFieldTemplate> Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

FilePropertiesAddTemplateResult

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for template added by See templates/add_for_user or templates/add_for_team.

FilePropertiesGetTemplateArg

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for template added by route See templates/add_for_user or templates/add_for_team.

FilePropertiesGetTemplateResult

Type:
  • Object
Properties:
Name Type Description
name string Display name for the template. Template names can be up to 256 bytes.
description string Description for the template. Template descriptions can be up to 1024 bytes.
fields Array.<FilePropertiesPropertyFieldTemplate> Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

FilePropertiesInvalidPropertyGroupError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_field_too_large' | 'does_not_fit_template' | 'duplicate_property_groups' Tag identifying the union variant.

FilePropertiesListTemplateResult

Type:
  • Object
Properties:
Name Type Description
template_ids Array.<Object> List of identifiers for templates added by See templates/add_for_user or templates/add_for_team.

FilePropertiesLogicalOperator

Logical operator to join search queries together.
Type:
  • Object
Properties:
Name Type Description
.tag 'or_operator' | 'other' Tag identifying the union variant.

FilePropertiesLookupError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_path string <optional>
 Available if .tag is malformed_path.
.tag 'malformed_path' | 'not_found' | 'not_file' | 'not_folder' | 'restricted_content' | 'other' Tag identifying the union variant.

FilePropertiesLookUpPropertiesError

Type:
  • Object
Properties:
Name Type Description
.tag 'property_group_not_found' | 'other' Tag identifying the union variant.

FilePropertiesModifyTemplateError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'conflicting_property_names' | 'too_many_properties' | 'too_many_templates' | 'template_attribute_too_large' Tag identifying the union variant.

FilePropertiesOverwritePropertyGroupArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
property_groups Array.<FilePropertiesPropertyGroup> The property groups "snapshot" updates to force apply. No two groups in the input should refer to the same template.

FilePropertiesPropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' Tag identifying the union variant.

FilePropertiesPropertiesSearchArg

Type:
  • Object
Properties:
Name Type Description
queries Array.<FilePropertiesPropertiesSearchQuery> Queries to search.
template_filter FilePropertiesTemplateFilter Filter results to contain only properties associated with these template IDs.

FilePropertiesPropertiesSearchContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to properties/search or properties/search/continue.

FilePropertiesPropertiesSearchContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

FilePropertiesPropertiesSearchError

Type:
  • Object
Properties:
Name Type Argument Description
property_group_lookup FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is property_group_lookup.
.tag 'property_group_lookup' | 'other' Tag identifying the union variant.

FilePropertiesPropertiesSearchMatch

Type:
  • Object
Properties:
Name Type Description
id string The ID for the matched file or folder.
path string The path for the matched file or folder.
is_deleted boolean Whether the file or folder is deleted.
property_groups Array.<FilePropertiesPropertyGroup> List of custom property groups associated with the file.

FilePropertiesPropertiesSearchMode

Type:
  • Object
Properties:
Name Type Argument Description
field_name string <optional>
 Available if .tag is field_name. Search for a value associated with this field name.
.tag 'field_name' | 'other' Tag identifying the union variant.

FilePropertiesPropertiesSearchQuery

Type:
  • Object
Properties:
Name Type Description
query string The property field value for which to search across templates.
mode FilePropertiesPropertiesSearchMode The mode with which to perform the search.
logical_operator FilePropertiesLogicalOperator The logical operator with which to append the query.

FilePropertiesPropertiesSearchResult

Type:
  • Object
Properties:
Name Type Argument Description
matches Array.<FilePropertiesPropertiesSearchMatch> A list (possibly empty) of matches for the query.
cursor string <optional>
 Pass the cursor into properties/search/continue to continue to receive search results. Cursor will be null when there are no more results.

FilePropertiesPropertyField

Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a PropertyGroup.
Type:
  • Object
Properties:
Name Type Description
name string Key of the property field associated with a file and template. Keys can be up to 256 bytes.
value string Value of the property field associated with a file and template. Values can be up to 1024 bytes.

FilePropertiesPropertyFieldTemplate

Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.
Type:
  • Object
Properties:
Name Type Description
name string Key of the property field being described. Property field keys can be up to 256 bytes.
description string Description of the property field. Property field descriptions can be up to 1024 bytes.
type FilePropertiesPropertyType Data type of the value of this property field. This type will be enforced upon property creation and modifications.

FilePropertiesPropertyGroup

A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate.
Type:
  • Object
Properties:
Name Type Description
template_id string A unique identifier for the associated template.
fields Array.<FilePropertiesPropertyField> The actual properties associated with the template. There can be up to 32 property types per template.

FilePropertiesPropertyGroupTemplate

Defines how a property group may be structured.
Type:
  • Object
Properties:
Name Type Description
name string Display name for the template. Template names can be up to 256 bytes.
description string Description for the template. Template descriptions can be up to 1024 bytes.
fields Array.<FilePropertiesPropertyFieldTemplate> Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

FilePropertiesPropertyGroupUpdate

Type:
  • Object
Properties:
Name Type Argument Description
template_id string A unique identifier for a property template.
add_or_update_fields Array.<FilePropertiesPropertyField> <optional>
 Property fields to update. If the property field already exists, it is updated. If the property field doesn't exist, the property group is added.
remove_fields Array.<string> <optional>
 Property fields to remove (by name), provided they exist.

FilePropertiesPropertyType

Data type of the given property field added.
Type:
  • Object
Properties:
Name Type Description
.tag 'string' | 'other' Tag identifying the union variant.

FilePropertiesRemovePropertiesArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
property_template_ids Array.<Object> A list of identifiers for a template created by templates/add_for_user or templates/add_for_team.

FilePropertiesRemovePropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
property_group_lookup FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is property_group_lookup.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_group_lookup' Tag identifying the union variant.

FilePropertiesRemoveTemplateArg

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for a template created by templates/add_for_user or templates/add_for_team.

FilePropertiesTemplateError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
.tag 'template_not_found' | 'restricted_content' | 'other' Tag identifying the union variant.

FilePropertiesTemplateFilter

Type:
  • Object
Properties:
Name Type Argument Description
filter_some Array.<Object> <optional>
 Available if .tag is filter_some. Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).
.tag 'filter_some' | 'other' | 'filter_none' Tag identifying the union variant.

FilePropertiesTemplateFilterBase

Type:
  • Object
Properties:
Name Type Argument Description
filter_some Array.<Object> <optional>
 Available if .tag is filter_some. Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).
.tag 'filter_some' | 'other' Tag identifying the union variant.

FilePropertiesTemplateOwnerType

Type:
  • Object
Properties:
Name Type Description
.tag 'user' | 'team' | 'other' Tag identifying the union variant.

FilePropertiesUpdatePropertiesArg

Type:
  • Object
Properties:
Name Type Description
path string A unique identifier for the file or folder.
update_property_groups Array.<FilePropertiesPropertyGroupUpdate> - The property groups "delta" updates to apply.

FilePropertiesUpdatePropertiesError

Type:
  • Object
Properties:
Name Type Argument Description
template_not_found string <optional>
 Available if .tag is template_not_found. Template does not exist for the given identifier.
path FilePropertiesLookupError <optional>
 Available if .tag is path.
property_group_lookup FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is property_group_lookup.
.tag 'template_not_found' | 'restricted_content' | 'other' | 'path' | 'unsupported_folder' | 'property_field_too_large' | 'does_not_fit_template' | 'duplicate_property_groups' | 'property_group_lookup' Tag identifying the union variant.

FilePropertiesUpdateTemplateArg

Type:
  • Object
Properties:
Name Type Argument Description
template_id string An identifier for template added by See templates/add_for_user or templates/add_for_team.
name string <optional>
 A display name for the template. template names can be up to 256 bytes.
description string <optional>
 Description for the new template. Template descriptions can be up to 1024 bytes.
add_fields Array.<FilePropertiesPropertyFieldTemplate> <optional>
 Property field templates to be added to the group template. There can be up to 32 properties in a single template.

FilePropertiesUpdateTemplateResult

Type:
  • Object
Properties:
Name Type Description
template_id string An identifier for template added by route See templates/add_for_user or templates/add_for_team.

FileRequestsCountFileRequestsError

There was an error counting the file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' Tag identifying the union variant.

FileRequestsCountFileRequestsResult

Result for count.
Type:
  • Object
Properties:
Name Type Description
file_request_count number The number file requests owner by this user.

FileRequestsCreateFileRequestArgs

Arguments for create.
Type:
  • Object
Properties:
Name Type Argument Description
title string The title of the file request. Must not be empty.
destination string The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
deadline FileRequestsFileRequestDeadline <optional>
 The deadline for the file request. Deadlines can only be set by Professional and Business accounts.
open boolean Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.
description string <optional>
 A description of the file request.

FileRequestsCreateFileRequestError

There was an error creating the file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' | 'invalid_location' | 'rate_limit' Tag identifying the union variant.

FileRequestsDeleteAllClosedFileRequestsError

There was an error deleting all closed file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FileRequestsDeleteAllClosedFileRequestsResult

Result for delete_all_closed.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests deleted for this user.

FileRequestsDeleteFileRequestArgs

Arguments for delete.
Type:
  • Object
Properties:
Name Type Description
ids Array.<Object> List IDs of the file requests to delete.

FileRequestsDeleteFileRequestError

There was an error deleting these file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' | 'file_request_open' Tag identifying the union variant.

FileRequestsDeleteFileRequestsResult

Result for delete.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests deleted by the request.

FileRequestsFileRequest

A file request https://www.dropbox.com/help/9090 for receiving files into the user's Dropbox account.
Type:
  • Object
Properties:
Name Type Argument Description
id string The ID of the file request.
url string The URL of the file request.
title string The title of the file request.
created Timestamp When this file request was created.
is_open boolean Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions.
file_count number The number of files this file request has received.
destination string <optional>
 The path of the folder in the Dropbox where uploaded files will be sent. This can be null if the destination was removed. For apps with the app folder permission, this will be relative to the app folder.
deadline FileRequestsFileRequestDeadline <optional>
 The deadline for this file request. Only set if the request has a deadline.
description string <optional>
 A description of the file request.

FileRequestsFileRequestDeadline

Type:
  • Object
Properties:
Name Type Argument Description
deadline Timestamp The deadline for this file request.
allow_late_uploads FileRequestsGracePeriod <optional>
 If set, allow uploads after the deadline has passed. These uploads will be marked overdue.

FileRequestsFileRequestError

There is an error with the file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FileRequestsGeneralFileRequestsError

There is an error accessing the file requests functionality.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' Tag identifying the union variant.

FileRequestsGetFileRequestArgs

Arguments for get.
Type:
  • Object
Properties:
Name Type Description
id string The ID of the file request to retrieve.

FileRequestsGetFileRequestError

There was an error retrieving the specified file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FileRequestsGracePeriod

Type:
  • Object
Properties:
Name Type Description
.tag 'one_day' | 'two_days' | 'seven_days' | 'thirty_days' | 'always' | 'other' Tag identifying the union variant.

FileRequestsListFileRequestsArg

Arguments for list:2.
Type:
  • Object
Properties:
Name Type Description
limit number The maximum number of file requests that should be returned per request.

FileRequestsListFileRequestsContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by the previous API call specified in the endpoint description.

FileRequestsListFileRequestsContinueError

There was an error retrieving the file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'invalid_cursor' Tag identifying the union variant.

FileRequestsListFileRequestsError

There was an error retrieving the file requests.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' Tag identifying the union variant.

FileRequestsListFileRequestsResult

Result for list.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.

FileRequestsListFileRequestsV2Result

Result for list:2 and list/continue.
Type:
  • Object
Properties:
Name Type Description
file_requests Array.<FileRequestsFileRequest> The file requests owned by this user. Apps with the app folder permission will only see file requests in their app folder.
cursor string Pass the cursor into list/continue to obtain additional file requests.
has_more boolean Is true if there are additional file requests that have not been returned yet. An additional call to :route:list/continue` can retrieve them.

FileRequestsUpdateFileRequestArgs

Arguments for update.
Type:
  • Object
Properties:
Name Type Argument Description
id string The ID of the file request to update.
title string <optional>
 The new title of the file request. Must not be empty.
destination string <optional>
 The new path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
deadline FileRequestsUpdateFileRequestDeadline The new deadline for the file request. Deadlines can only be set by Professional and Business accounts.
open boolean <optional>
 Whether to set this file request as open or closed.
description string <optional>
 The description of the file request.

FileRequestsUpdateFileRequestDeadline

Type:
  • Object
Properties:
Name Type Argument Description
update FileRequestsFileRequestDeadline <optional>
 Available if .tag is update. If :val:`null`, the file request's deadline is cleared.
.tag 'no_update' | 'update' | 'other' Tag identifying the union variant.

FileRequestsUpdateFileRequestError

There is an error updating the file request.
Type:
  • Object
Properties:
Name Type Description
.tag 'disabled_for_team' | 'other' | 'not_found' | 'not_a_folder' | 'app_lacks_access' | 'no_permission' | 'email_unverified' | 'validation_error' Tag identifying the union variant.

FilesAddTagArg

Type:
  • Object
Properties:
Name Type Description
path string Path to the item to be tagged.
tag_text string The value of the tag to add. Will be automatically converted to lowercase letters.

FilesAddTagError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' | 'too_many_tags' Tag identifying the union variant.

FilesAlphaGetMetadataArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of a file or folder on Dropbox.
include_media_info boolean If true, FileMetadata.media_info is set for photo and video.
include_deleted boolean If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned.
include_has_explicit_shared_members boolean If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
include_property_groups FilePropertiesTemplateFilterBase <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.
include_property_templates Array.<Object> <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set for files with custom properties.

FilesAlphaGetMetadataError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
properties_error FilePropertiesLookUpPropertiesError <optional>
 Available if .tag is properties_error.
.tag 'path' | 'properties_error' Tag identifying the union variant.

FilesBaseTagError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesCommitInfo

Type:
  • Object
Properties:
Name Type Argument Description
path string Path in the user's Dropbox to save the file.
mode FilesWriteMode Selects what to do if the file already exists.
autorename boolean If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
client_modified Timestamp <optional>
 The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
mute boolean Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 List of custom properties to add to file.
strict_conflict boolean Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.

FilesContentSyncSetting

Type:
  • Object
Properties:
Name Type Description
id string Id of the item this setting is applied to.
sync_setting FilesSyncSetting Setting for this item.

FilesContentSyncSettingArg

Type:
  • Object
Properties:
Name Type Description
id string Id of the item this setting is applied to.
sync_setting FilesSyncSettingArg Setting for this item.

FilesCreateFolderArg

Type:
  • Object
Properties:
Name Type Description
path string Path in the user's Dropbox to create.
autorename boolean If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.

FilesCreateFolderBatchArg

Type:
  • Object
Properties:
Name Type Description
paths Array.<Object> List of paths to be created in the user's Dropbox. Duplicate path arguments in the batch are considered only once.
autorename boolean If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
force_async boolean Whether to force the create to happen asynchronously.

FilesCreateFolderBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_files' | 'other' Tag identifying the union variant.

FilesCreateFolderBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesCreateFolderBatchResult <optional>
 Available if .tag is complete. The batch create folder has finished.
failed FilesCreateFolderBatchError <optional>
 Available if .tag is failed. The batch create folder has failed.
.tag 'in_progress' | 'complete' | 'failed' | 'other' Tag identifying the union variant.

FilesCreateFolderBatchLaunch

Result returned by create_folder_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete FilesCreateFolderBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesCreateFolderBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesCreateFolderBatchResultEntry> Each entry in CreateFolderBatchArg.paths will appear at the same position inside CreateFolderBatchResult.entries.

FilesCreateFolderBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesCreateFolderEntryResult <optional>
 Available if .tag is success.
failure FilesCreateFolderEntryError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesCreateFolderEntryError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesCreateFolderEntryResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFolderMetadata Metadata of the created folder.

FilesCreateFolderError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' Tag identifying the union variant.

FilesCreateFolderResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFolderMetadata Metadata of the created folder.

FilesDeleteArg

Type:
  • Object
Properties:
Name Type Argument Description
path string Path in the user's Dropbox to delete.
parent_rev string <optional>
 Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.

FilesDeleteBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesDeleteArg>

FilesDeleteBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_write_operations' | 'other' Tag identifying the union variant.

FilesDeleteBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesDeleteBatchResult <optional>
 Available if .tag is complete. The batch delete has finished.
failed FilesDeleteBatchError <optional>
 Available if .tag is failed. The batch delete has failed.
.tag 'in_progress' | 'complete' | 'failed' | 'other' Tag identifying the union variant.

FilesDeleteBatchLaunch

Result returned by delete_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete FilesDeleteBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesDeleteBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesDeleteBatchResultEntry> Each entry in DeleteBatchArg.entries will appear at the same position inside DeleteBatchResult.entries.

FilesDeleteBatchResultData

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the deleted object.

FilesDeleteBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesDeleteBatchResultData <optional>
 Available if .tag is success.
failure FilesDeleteError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesDeletedMetadata

Indicates that there used to be a file or folder at this path, but it no longer exists.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'deleted' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
name string The last component of the path (including extension). This never contains a slash.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.

FilesDeleteError

Type:
  • Object
Properties:
Name Type Argument Description
path_lookup FilesLookupError <optional>
 Available if .tag is path_lookup.
path_write FilesWriteError <optional>
 Available if .tag is path_write.
.tag 'path_lookup' | 'path_write' | 'too_many_write_operations' | 'too_many_files' | 'other' Tag identifying the union variant.

FilesDeleteResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the deleted object.

FilesDimensions

Dimensions for a photo or video.
Type:
  • Object
Properties:
Name Type Description
height number Height of the photo/video.
width number Width of the photo/video.

FilesDownloadArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of the file to download.
rev string <optional>
 Please specify revision in path instead.

FilesDownloadError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'unsupported_file' | 'other' Tag identifying the union variant.

FilesDownloadZipArg

Type:
  • Object
Properties:
Name Type Description
path string The path of the folder to download.

FilesDownloadZipError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'too_large' | 'too_many_files' | 'other' Tag identifying the union variant.

FilesDownloadZipResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFolderMetadata

FilesExportArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of the file to be exported.
export_format string <optional>
 The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by get_metadata. If none is specified, the default format (specified in export_as in file metadata) will be used.

FilesExportError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'non_exportable' | 'invalid_export_format' | 'retry_error' | 'other' Tag identifying the union variant.

FilesExportInfo

Export information for a file.
Type:
  • Object
Properties:
Name Type Argument Description
export_as string <optional>
 Format to which the file can be exported to.
export_options Array.<string> <optional>
 Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export.

FilesExportMetadata

Type:
  • Object
Properties:
Name Type Argument Description
name string The last component of the path (including extension). This never contains a slash.
size number The file size in bytes.
export_hash string <optional>
 A hash based on the exported file content. This field can be used to verify data integrity. Similar to content hash. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.
paper_revision number <optional>
 If the file is a Paper doc, this gives the latest doc revision which can be used in paper/update.

FilesExportResult

Type:
  • Object
Properties:
Name Type Description
export_metadata FilesExportMetadata Metadata for the exported version of the file.
file_metadata FilesFileMetadata Metadata for the original file.

FilesFileCategory

Type:
  • Object
Properties:
Name Type Description
.tag 'image' | 'document' | 'pdf' | 'spreadsheet' | 'presentation' | 'audio' | 'video' | 'folder' | 'paper' | 'others' | 'other' Tag identifying the union variant.

FilesFileLock

Type:
  • Object
Properties:
Name Type Description
content FilesFileLockContent The lock description.

FilesFileLockContent

Type:
  • Object
Properties:
Name Type Argument Description
single_user FilesSingleUserLock <optional>
 Available if .tag is single_user. A lock held by a single user.
.tag 'unlocked' | 'single_user' | 'other' Tag identifying the union variant.

FilesFileLockMetadata

Type:
  • Object
Properties:
Name Type Argument Description
is_lockholder boolean <optional>
 True if caller holds the file lock.
lockholder_name string <optional>
 The display name of the lock holder.
lockholder_account_id string <optional>
 The account ID of the lock holder if known.
created Timestamp <optional>
 The timestamp of the lock was created.

FilesFileMetadata

Type:
  • Object
Properties:
Name Type Argument Description
.tag 'file' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
name string The last component of the path (including extension). This never contains a slash.
id string A unique identifier for the file.
client_modified Timestamp For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.
server_modified Timestamp The last time the file was modified on Dropbox.
rev string A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
size number The file size in bytes.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.
media_info FilesMediaInfo <optional>
 Additional information if the file is a photo or video. This field will not be set on entries returned by list_folder, list_folder/continue, or get_thumbnail_batch, starting December 2, 2019.
symlink_info FilesSymlinkInfo <optional>
 Set if this file is a symlink.
sharing_info FilesFileSharingInfo <optional>
 Set if this file is contained in a shared folder.
is_downloadable boolean If true, file can be downloaded directly; else the file must be exported.
export_info FilesExportInfo <optional>
 Information about format this file can be exported to. This filed must be set if is_downloadable is set to false.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 Additional information if the file has custom properties with the property template specified.
has_explicit_shared_members boolean <optional>
 This flag will only be present if include_has_explicit_shared_members is true in list_folder or get_metadata. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.
content_hash string <optional>
 A hash of the file content. This field can be used to verify data integrity. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.
file_lock_info FilesFileLockMetadata <optional>
 If present, the metadata associated with the file's current lock.

FilesFileOpsResult

Type:
  • Object

FilesFileSharingInfo

Sharing info for a file which is contained by a shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
read_only boolean True if the file or folder is inside a read-only shared folder.
parent_shared_folder_id string ID of shared folder that holds this file.
modified_by string <optional>
 The last user who modified the file. This field will be null if the user's account has been deleted.

FilesFileStatus

Type:
  • Object
Properties:
Name Type Description
.tag 'active' | 'deleted' | 'other' Tag identifying the union variant.

FilesFolderMetadata

Type:
  • Object
Properties:
Name Type Argument Description
.tag 'folder' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
name string The last component of the path (including extension). This never contains a slash.
id string A unique identifier for the folder.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.
shared_folder_id string <optional>
 Please use sharing_info instead.
sharing_info FilesFolderSharingInfo <optional>
 Set if the folder is contained in a shared folder or is a shared folder mount point.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.

FilesFolderSharingInfo

Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.
Type:
  • Object
Properties:
Name Type Argument Description
read_only boolean True if the file or folder is inside a read-only shared folder.
parent_shared_folder_id string <optional>
 Set if the folder is contained by a shared folder.
shared_folder_id string <optional>
 If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
traverse_only boolean Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder.
no_access boolean Specifies that the folder cannot be accessed by the user.

FilesGetCopyReferenceArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the file or folder you want to get a copy reference to.

FilesGetCopyReferenceError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesGetCopyReferenceResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the file or folder.
copy_reference string A copy reference to the file or folder.
expires Timestamp The expiration date of the copy reference. This value is currently set to be far enough in the future so that expiration is effectively not an issue.

FilesGetMetadataArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of a file or folder on Dropbox.
include_media_info boolean If true, FileMetadata.media_info is set for photo and video.
include_deleted boolean If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned.
include_has_explicit_shared_members boolean If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
include_property_groups FilePropertiesTemplateFilterBase <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.

FilesGetMetadataError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' Tag identifying the union variant.

FilesGetTagsArg

Type:
  • Object
Properties:
Name Type Description
paths Array.<Object> Path to the items.

FilesGetTagsResult

Type:
  • Object
Properties:
Name Type Description
paths_to_tags Array.<FilesPathToTags> List of paths and their corresponding tags.

FilesGetTemporaryLinkArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the file you want a temporary link to.

FilesGetTemporaryLinkError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'email_not_verified' | 'unsupported_file' | 'not_allowed' | 'other' Tag identifying the union variant.

FilesGetTemporaryLinkResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata Metadata of the file.
link string The temporary link which can be used to stream content the file.

FilesGetTemporaryUploadLinkArg

Type:
  • Object
Properties:
Name Type Description
commit_info FilesCommitInfo Contains the path and other optional modifiers for the future upload commit. Equivalent to the parameters provided to upload.
duration number How long before this link expires, in seconds. Attempting to start an upload with this link longer than this period of time after link creation will result in an error.

FilesGetTemporaryUploadLinkResult

Type:
  • Object
Properties:
Name Type Description
link string The temporary link which can be used to stream a file to a Dropbox location.

FilesGetThumbnailBatchArg

Arguments for get_thumbnail_batch.
Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesThumbnailArg> List of files to get thumbnails.

FilesGetThumbnailBatchError

Type:
  • Object
Properties:
Name Type Description
.tag 'too_many_files' | 'other' Tag identifying the union variant.

FilesGetThumbnailBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesGetThumbnailBatchResultEntry> List of files and their thumbnails.

FilesGetThumbnailBatchResultData

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata
thumbnail string A string containing the base64-encoded thumbnail data for this file.

FilesGetThumbnailBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesGetThumbnailBatchResultData <optional>
 Available if .tag is success.
failure FilesThumbnailError <optional>
 Available if .tag is failure. The result for this file if it was an error.
.tag 'success' | 'failure' | 'other' Tag identifying the union variant.

FilesGpsCoordinates

GPS coordinates for a photo or video.
Type:
  • Object
Properties:
Name Type Description
latitude number Latitude of the GPS coordinates.
longitude number Longitude of the GPS coordinates.

FilesHighlightSpan

Type:
  • Object
Properties:
Name Type Description
highlight_str string String to be determined whether it should be highlighted or not.
is_highlighted boolean The string should be highlighted or not.

FilesImportFormat

The import format of the incoming Paper doc content.
Type:
  • Object
Properties:
Name Type Description
.tag 'html' | 'markdown' | 'plain_text' | 'other' Tag identifying the union variant.

FilesListFolderArg

Type:
  • Object
Properties:
Name Type Argument Description
path string A unique identifier for the file.
recursive boolean If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.
include_media_info boolean If true, FileMetadata.media_info is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.
include_deleted boolean If true, the results will include entries for files and folders that used to exist but were deleted.
include_has_explicit_shared_members boolean If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
include_mounted_folders boolean If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
limit number <optional>
 The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
shared_link FilesSharedLink <optional>
 A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, ListFolderArg.path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
include_property_groups FilePropertiesTemplateFilterBase <optional>
 If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.
include_non_downloadable_files boolean If true, include files that are not downloadable, i.e. Google Docs.

FilesListFolderContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to list_folder or list_folder/continue.

FilesListFolderContinueError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'reset' | 'other' Tag identifying the union variant.

FilesListFolderError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
template_error FilePropertiesTemplateError <optional>
 Available if .tag is template_error.
.tag 'path' | 'template_error' | 'other' Tag identifying the union variant.

FilesListFolderGetLatestCursorResult

Type:
  • Object
Properties:
Name Type Description
cursor string Pass the cursor into list_folder/continue to see what's changed in the folder since your previous query.

FilesListFolderLongpollArg

Type:
  • Object
Properties:
Name Type Description
cursor string A cursor as returned by list_folder or list_folder/continue. Cursors retrieved by setting ListFolderArg.include_media_info to true are not supported.
timeout number A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.

FilesListFolderLongpollError

Type:
  • Object
Properties:
Name Type Description
.tag 'reset' | 'other' Tag identifying the union variant.

FilesListFolderLongpollResult

Type:
  • Object
Properties:
Name Type Argument Description
changes boolean Indicates whether new changes are available. If true, call list_folder/continue to retrieve the changes.
backoff number <optional>
 If present, backoff for at least this many seconds before calling list_folder/longpoll again.

FilesListFolderResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)> The files and (direct) subfolders in the folder.
cursor string Pass the cursor into list_folder/continue to see what's changed in the folder since your previous query.
has_more boolean If true, then there are more entries available. Pass the cursor to list_folder/continue to retrieve the rest.

FilesListRevisionsArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the file you want to see the revisions of.
mode FilesListRevisionsMode Determines the behavior of the API in listing the revisions for a given file path or id.
limit number The maximum number of revision entries returned.

FilesListRevisionsError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

FilesListRevisionsMode

Type:
  • Object
Properties:
Name Type Description
.tag 'path' | 'id' | 'other' Tag identifying the union variant.

FilesListRevisionsResult

Type:
  • Object
Properties:
Name Type Argument Description
is_deleted boolean If the file identified by the latest revision in the response is either deleted or moved.
entries Array.<FilesFileMetadata> The revisions for the file. Only revisions that are not deleted will show up here.
server_deleted Timestamp <optional>
 The time of deletion if the file was deleted.

FilesLockConflictError

Type:
  • Object
Properties:
Name Type Description
lock FilesFileLock The lock that caused the conflict.

FilesLockFileArg

Type:
  • Object
Properties:
Name Type Description
path string Path in the user's Dropbox to a file.

FilesLockFileBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesLockFileArg> List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.

FilesLockFileBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesLockFileResultEntry> Each Entry in the 'entries' will have '.tag' with the operation status (e.g. success), the metadata for the file and the lock state after the operation.

FilesLockFileError

Type:
  • Object
Properties:
Name Type Argument Description
path_lookup FilesLookupError <optional>
 Available if .tag is path_lookup. Could not find the specified resource.
lock_conflict FilesLockConflictError <optional>
 Available if .tag is lock_conflict. The user action conflicts with an existing lock on the file.
.tag 'path_lookup' | 'too_many_write_operations' | 'too_many_files' | 'no_write_permission' | 'cannot_be_locked' | 'file_not_shared' | 'lock_conflict' | 'internal_error' | 'other' Tag identifying the union variant.

FilesLockFileResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the file.
lock FilesFileLock The file lock state after the operation.

FilesLockFileResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesLockFileResult <optional>
 Available if .tag is success.
failure FilesLockFileError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesLookupError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_path string <optional>
 Available if .tag is malformed_path. The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information.
.tag 'malformed_path' | 'not_found' | 'not_file' | 'not_folder' | 'restricted_content' | 'unsupported_content_type' | 'locked' | 'other' Tag identifying the union variant.

FilesMediaInfo

Type:
  • Object
Properties:
Name Type Argument Description
metadata FilesPhotoMetadata | FilesVideoMetadata <optional>
 Available if .tag is metadata. The metadata for the photo/video.
.tag 'pending' | 'metadata' Tag identifying the union variant.

FilesMediaMetadata

Metadata for a photo or video.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "photo" | "video" Tag identifying the subtype variant.
dimensions FilesDimensions <optional>
 Dimension of the photo/video.
location FilesGpsCoordinates <optional>
 The GPS coordinate of the photo/video.
time_taken Timestamp <optional>
 The timestamp when the photo/video is taken.

FilesMetadata

Metadata for a file or folder.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "file" | "folder" | "deleted" Tag identifying the subtype variant.
name string The last component of the path (including extension). This never contains a slash.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by list_folder/continue. This field will be null if the file or folder is not mounted.
parent_shared_folder_id string <optional>
 Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.
preview_url string <optional>
 The preview URL of the file.

FilesMetadataV2

Metadata for a file, folder or other resource types.
Type:
  • Object
Properties:
Name Type Argument Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata <optional>
 Available if .tag is metadata.
.tag 'metadata' | 'other' Tag identifying the union variant.

FilesMinimalFileLinkMetadata

Type:
  • Object
Properties:
Name Type Argument Description
url string URL of the shared link.
rev string A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
id string <optional>
 Unique identifier for the linked file.
path string <optional>
 Full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's Dropbox.

FilesMoveBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationPath> List of entries to be moved or copied. Each entry is RelocationPath.
autorename boolean If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
allow_ownership_transfer boolean Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

FilesMoveIntoFamilyError

Type:
  • Object
Properties:
Name Type Description
.tag 'is_shared_folder' | 'other' Tag identifying the union variant.

FilesMoveIntoVaultError

Type:
  • Object
Properties:
Name Type Description
.tag 'is_shared_folder' | 'other' Tag identifying the union variant.

FilesPaperContentError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'content_malformed' | 'doc_length_exceeded' | 'image_size_exceeded' | 'other' Tag identifying the union variant.

FilesPaperCreateArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
path string The fully qualified path to the location in the user's Dropbox where the Paper Doc should be created. This should include the document's title and end with .paper.
import_format FilesImportFormat The format of the provided data.

FilesPaperCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'content_malformed' | 'doc_length_exceeded' | 'image_size_exceeded' | 'other' | 'invalid_path' | 'email_unverified' | 'invalid_file_extension' | 'paper_disabled' Tag identifying the union variant.

FilesPaperCreateResult

Type:
  • Object
Properties:
Name Type Description
url string URL to open the Paper Doc.
result_path string The fully qualified path the Paper Doc was actually created at.
file_id string The id to use in Dropbox APIs when referencing the Paper Doc.
paper_revision number The current doc revision.

FilesPaperDocUpdatePolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'update' | 'overwrite' | 'prepend' | 'append' | 'other' Tag identifying the union variant.

FilesPaperUpdateArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
path string Path in the user's Dropbox to update. The path must correspond to a Paper doc or an error will be returned.
import_format FilesImportFormat The format of the provided data.
doc_update_policy FilesPaperDocUpdatePolicy How the provided content should be applied to the doc.
paper_revision number <optional>
 The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.

FilesPaperUpdateError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'insufficient_permissions' | 'content_malformed' | 'doc_length_exceeded' | 'image_size_exceeded' | 'other' | 'path' | 'revision_mismatch' | 'doc_archived' | 'doc_deleted' Tag identifying the union variant.

FilesPaperUpdateResult

Type:
  • Object
Properties:
Name Type Description
paper_revision number The current doc revision.
Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 Available if .tag is path.
link FilesSharedLinkFileInfo <optional>
 Available if .tag is link.
.tag 'path' | 'link' | 'other' Tag identifying the union variant.

FilesPathToTags

Type:
  • Object
Properties:
Name Type Description
path string Path of the item.
tags Array.<FilesTag> Tags assigned to this item.

FilesPhotoMetadata

Metadata for a photo.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'photo' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
dimensions FilesDimensions <optional>
 Dimension of the photo/video.
location FilesGpsCoordinates <optional>
 The GPS coordinate of the photo/video.
time_taken Timestamp <optional>
 The timestamp when the photo/video is taken.

FilesPreviewArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path of the file to preview.
rev string <optional>
 Please specify revision in path instead.

FilesPreviewError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path. An error occurs when downloading metadata for the file.
.tag 'path' | 'in_progress' | 'unsupported_extension' | 'unsupported_content' Tag identifying the union variant.

FilesPreviewResult

Type:
  • Object
Properties:
Name Type Argument Description
file_metadata FilesFileMetadata <optional>
 Metadata corresponding to the file received as an argument. Will be populated if the endpoint is called with a path (ReadPath).
link_metadata FilesMinimalFileLinkMetadata <optional>
 Minimal metadata corresponding to the file received as an argument. Will be populated if the endpoint is called using a shared link (SharedLinkFileInfo).

FilesRelocationArg

Type:
  • Object
Properties:
Name Type Description
from_path string Path in the user's Dropbox to be copied or moved.
to_path string Path in the user's Dropbox that is the destination.
allow_shared_folder boolean This flag has no effect.
autorename boolean If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
allow_ownership_transfer boolean Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

FilesRelocationBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationPath> List of entries to be moved or copied. Each entry is RelocationPath.
autorename boolean If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
allow_shared_folder boolean This flag has no effect.
allow_ownership_transfer boolean Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

FilesRelocationBatchArgBase

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationPath> List of entries to be moved or copied. Each entry is RelocationPath.
autorename boolean If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.

FilesRelocationBatchError

Type:
  • Object
Properties:
Name Type Argument Description
from_lookup FilesLookupError <optional>
 Available if .tag is from_lookup.
from_write FilesWriteError <optional>
 Available if .tag is from_write.
to FilesWriteError <optional>
 Available if .tag is to.
cant_move_into_vault FilesMoveIntoVaultError <optional>
 Available if .tag is cant_move_into_vault. Some content cannot be moved into Vault under certain circumstances, see detailed error.
cant_move_into_family FilesMoveIntoFamilyError <optional>
 Available if .tag is cant_move_into_family. Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
.tag 'from_lookup' | 'from_write' | 'to' | 'cant_copy_shared_folder' | 'cant_nest_shared_folder' | 'cant_move_folder_into_itself' | 'too_many_files' | 'duplicated_or_nested_paths' | 'cant_transfer_ownership' | 'insufficient_quota' | 'internal_error' | 'cant_move_shared_folder' | 'cant_move_into_vault' | 'cant_move_into_family' | 'other' | 'too_many_write_operations' Tag identifying the union variant.

FilesRelocationBatchErrorEntry

Type:
  • Object
Properties:
Name Type Argument Description
relocation_error FilesRelocationError <optional>
 Available if .tag is relocation_error. User errors that retry won't help.
.tag 'relocation_error' | 'internal_error' | 'too_many_write_operations' | 'other' Tag identifying the union variant.

FilesRelocationBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesRelocationBatchResult <optional>
 Available if .tag is complete. The copy or move batch job has finished.
failed FilesRelocationBatchError <optional>
 Available if .tag is failed. The copy or move batch job has failed with exception.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

FilesRelocationBatchLaunch

Result returned by copy_batch or move_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete FilesRelocationBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesRelocationBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationBatchResultData>

FilesRelocationBatchResultData

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the relocated object.

FilesRelocationBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata <optional>
 Available if .tag is success.
failure FilesRelocationBatchErrorEntry <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' | 'other' Tag identifying the union variant.

FilesRelocationBatchV2JobStatus

Result returned by copy_batch/check:2 or move_batch/check:2 that may either be in progress or completed with result for each entry.
Type:
  • Object
Properties:
Name Type Argument Description
complete FilesRelocationBatchV2Result <optional>
 Available if .tag is complete. The copy or move batch job has finished.
.tag 'in_progress' | 'complete' Tag identifying the union variant.

FilesRelocationBatchV2Launch

Result returned by copy_batch:2 or move_batch:2 that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete FilesRelocationBatchV2Result <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

FilesRelocationBatchV2Result

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesRelocationBatchResultEntry> Each entry in CopyBatchArg.entries or MoveBatchArg.entries will appear at the same position inside RelocationBatchV2Result.entries.

FilesRelocationError

Type:
  • Object
Properties:
Name Type Argument Description
from_lookup FilesLookupError <optional>
 Available if .tag is from_lookup.
from_write FilesWriteError <optional>
 Available if .tag is from_write.
to FilesWriteError <optional>
 Available if .tag is to.
cant_move_into_vault FilesMoveIntoVaultError <optional>
 Available if .tag is cant_move_into_vault. Some content cannot be moved into Vault under certain circumstances, see detailed error.
cant_move_into_family FilesMoveIntoFamilyError <optional>
 Available if .tag is cant_move_into_family. Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
.tag 'from_lookup' | 'from_write' | 'to' | 'cant_copy_shared_folder' | 'cant_nest_shared_folder' | 'cant_move_folder_into_itself' | 'too_many_files' | 'duplicated_or_nested_paths' | 'cant_transfer_ownership' | 'insufficient_quota' | 'internal_error' | 'cant_move_shared_folder' | 'cant_move_into_vault' | 'cant_move_into_family' | 'other' Tag identifying the union variant.

FilesRelocationPath

Type:
  • Object
Properties:
Name Type Description
from_path string Path in the user's Dropbox to be copied or moved.
to_path string Path in the user's Dropbox that is the destination.

FilesRelocationResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata Metadata of the relocated object.

FilesRemoveTagArg

Type:
  • Object
Properties:
Name Type Description
path string Path to the item to tag.
tag_text string The tag to remove. Will be automatically converted to lowercase letters.

FilesRemoveTagError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' | 'tag_not_present' Tag identifying the union variant.

FilesRestoreArg

Type:
  • Object
Properties:
Name Type Description
path string The path to save the restored file.
rev string The revision to restore.

FilesRestoreError

Type:
  • Object
Properties:
Name Type Argument Description
path_lookup FilesLookupError <optional>
 Available if .tag is path_lookup. An error occurs when downloading metadata for the file.
path_write FilesWriteError <optional>
 Available if .tag is path_write. An error occurs when trying to restore the file to that path.
.tag 'path_lookup' | 'path_write' | 'invalid_revision' | 'in_progress' | 'other' Tag identifying the union variant.

FilesSaveCopyReferenceArg

Type:
  • Object
Properties:
Name Type Description
copy_reference string A copy reference returned by copy_reference/get.
path string Path in the user's Dropbox that is the destination.

FilesSaveCopyReferenceError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' | 'invalid_copy_reference' | 'no_permission' | 'not_found' | 'too_many_files' | 'other' Tag identifying the union variant.

FilesSaveCopyReferenceResult

Type:
  • Object
Properties:
Name Type Description
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata The metadata of the saved file or folder in the user's Dropbox.

FilesSaveUrlArg

Type:
  • Object
Properties:
Name Type Description
path string The path in Dropbox where the URL will be saved to.
url string The URL to be saved.

FilesSaveUrlError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesWriteError <optional>
 Available if .tag is path.
.tag 'path' | 'download_failed' | 'invalid_url' | 'not_found' | 'other' Tag identifying the union variant.

FilesSaveUrlJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesFileMetadata <optional>
 Available if .tag is complete. Metadata of the file where the URL is saved to.
failed FilesSaveUrlError <optional>
 Available if .tag is failed.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

FilesSaveUrlResult

Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete FilesFileMetadata <optional>
 Available if .tag is complete. Metadata of the file where the URL is saved to.
.tag 'async_job_id' | 'complete' Tag identifying the union variant.

FilesSearchArg

Type:
  • Object
Properties:
Name Type Description
path string The path in the user's Dropbox to search. Should probably be a folder.
query string The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car").
start number The starting index within the search results (used for paging).
max_results number The maximum number of search results to return.
mode FilesSearchMode The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.

FilesSearchError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
invalid_argument string <optional>
 Available if .tag is invalid_argument.
.tag 'path' | 'invalid_argument' | 'internal_error' | 'other' Tag identifying the union variant.

FilesSearchMatch

Type:
  • Object
Properties:
Name Type Description
match_type FilesSearchMatchType The type of the match.
metadata FilesFileMetadata | FilesFolderMetadata | FilesDeletedMetadata The metadata for the matched file or folder.

FilesSearchMatchFieldOptions

Type:
  • Object
Properties:
Name Type Description
include_highlights boolean Whether to include highlight span from file title.

FilesSearchMatchType

Indicates what type of match was found for a given item.
Type:
  • Object
Properties:
Name Type Description
.tag 'filename' | 'content' | 'both' Tag identifying the union variant.

FilesSearchMatchTypeV2

Indicates what type of match was found for a given item.
Type:
  • Object
Properties:
Name Type Description
.tag 'filename' | 'file_content' | 'filename_and_content' | 'image_content' | 'other' Tag identifying the union variant.

FilesSearchMatchV2

Type:
  • Object
Properties:
Name Type Argument Description
metadata FilesMetadataV2 The metadata for the matched file or folder.
match_type FilesSearchMatchTypeV2 <optional>
 The type of the match.
highlight_spans Array.<FilesHighlightSpan> <optional>
 The list of HighlightSpan determines which parts of the file title should be highlighted.

FilesSearchMode

Type:
  • Object
Properties:
Name Type Description
.tag 'filename' | 'filename_and_content' | 'deleted_filename' Tag identifying the union variant.

FilesSearchOptions

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified.
max_results number The maximum number of search results to return.
order_by FilesSearchOrderBy <optional>
 Specified property of the order of search results. By default, results are sorted by relevance.
file_status FilesFileStatus Restricts search to the given file status.
filename_only boolean Restricts search to only match on filenames.
file_extensions Array.<string> <optional>
 Restricts search to only the extensions specified. Only supported for active file search.
file_categories Array.<FilesFileCategory> <optional>
 Restricts search to only the file categories specified. Only supported for active file search.
account_id string <optional>
 Restricts results to the given account id.

FilesSearchOrderBy

Type:
  • Object
Properties:
Name Type Description
.tag 'relevance' | 'last_modified_time' | 'other' Tag identifying the union variant.

FilesSearchResult

Type:
  • Object
Properties:
Name Type Description
matches Array.<FilesSearchMatch> A list (possibly empty) of matches for the query.
more boolean Used for paging. If true, indicates there is another page of results available that can be fetched by calling search again.
start number Used for paging. Value to set the start argument to when calling search to fetch the next page of results.

FilesSearchV2Arg

Type:
  • Object
Properties:
Name Type Argument Description
query string The string to search for. May match across multiple fields based on the request arguments.
options FilesSearchOptions <optional>
 Options for more targeted search results.
match_field_options FilesSearchMatchFieldOptions <optional>
 Options for search results match fields.
include_highlights boolean <optional>
 Deprecated and moved this option to SearchMatchFieldOptions.

FilesSearchV2ContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to search:2. Used to fetch the next page of results.

FilesSearchV2Result

Type:
  • Object
Properties:
Name Type Argument Description
matches Array.<FilesSearchMatchV2> A list (possibly empty) of matches for the query.
has_more boolean Used for paging. If true, indicates there is another page of results available that can be fetched by calling search/continue:2 with the cursor.
cursor string <optional>
 Pass the cursor into search/continue:2 to fetch the next page of results.
Type:
  • Object
Properties:
Name Type Argument Description
url string Shared link url.
password string <optional>
 Password for the shared link.

FilesSharedLinkFileInfo

Type:
  • Object
Properties:
Name Type Argument Description
url string The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for.
path string <optional>
 The path corresponding to a file in a shared link to a folder. Required for shared links to folders.
password string <optional>
 Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie.

FilesSharingInfo

Sharing info for a file or folder.
Type:
  • Object
Properties:
Name Type Description
read_only boolean True if the file or folder is inside a read-only shared folder.

FilesSingleUserLock

Type:
  • Object
Properties:
Name Type Argument Description
created Timestamp The time the lock was created.
lock_holder_account_id string The account ID of the lock holder if known.
lock_holder_team_id string <optional>
 The id of the team of the account holder if it exists.

FilesSymlinkInfo

Type:
  • Object
Properties:
Name Type Description
target string The target this symlink points to.

FilesSyncSetting

Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'not_synced' | 'not_synced_inactive' | 'other' Tag identifying the union variant.

FilesSyncSettingArg

Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'not_synced' | 'other' Tag identifying the union variant.

FilesSyncSettingsError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'unsupported_combination' | 'unsupported_configuration' | 'other' Tag identifying the union variant.

FilesTag

Tag that can be added in multiple ways.
Type:
  • Object
Properties:
Name Type Argument Description
user_generated_tag FilesUserGeneratedTag <optional>
 Available if .tag is user_generated_tag. Tag generated by the user.
.tag 'user_generated_tag' | 'other' Tag identifying the union variant.

FilesThumbnailArg

Type:
  • Object
Properties:
Name Type Description
path string The path to the image file you want to thumbnail.
format FilesThumbnailFormat The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
size FilesThumbnailSize The size for the thumbnail image.
mode FilesThumbnailMode How to resize and crop the image to achieve the desired size.

FilesThumbnailError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path. An error occurs when downloading metadata for the image.
.tag 'path' | 'unsupported_extension' | 'unsupported_image' | 'conversion_error' Tag identifying the union variant.

FilesThumbnailFormat

Type:
  • Object
Properties:
Name Type Description
.tag 'jpeg' | 'png' Tag identifying the union variant.

FilesThumbnailMode

Type:
  • Object
Properties:
Name Type Description
.tag 'strict' | 'bestfit' | 'fitone_bestfit' Tag identifying the union variant.

FilesThumbnailSize

Type:
  • Object
Properties:
Name Type Description
.tag 'w32h32' | 'w64h64' | 'w128h128' | 'w256h256' | 'w480h320' | 'w640h480' | 'w960h640' | 'w1024h768' | 'w2048h1536' Tag identifying the union variant.

FilesThumbnailV2Arg

Type:
  • Object
Properties:
Name Type Description
resource FilesPathOrLink Information specifying which file to preview. This could be a path to a file, a shared link pointing to a file, or a shared link pointing to a folder, with a relative path.
format FilesThumbnailFormat The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
size FilesThumbnailSize The size for the thumbnail image.
mode FilesThumbnailMode How to resize and crop the image to achieve the desired size.

FilesThumbnailV2Error

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path. An error occurred when downloading metadata for the image.
.tag 'path' | 'unsupported_extension' | 'unsupported_image' | 'conversion_error' | 'access_denied' | 'not_found' | 'other' Tag identifying the union variant.

FilesUnlockFileArg

Type:
  • Object
Properties:
Name Type Description
path string Path in the user's Dropbox to a file.

FilesUnlockFileBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesUnlockFileArg> List of 'entries'. Each 'entry' contains a path of the file which will be unlocked. Duplicate path arguments in the batch are considered only once.

FilesUploadArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
path string Path in the user's Dropbox to save the file.
mode FilesWriteMode Selects what to do if the file already exists.
autorename boolean If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
client_modified Timestamp <optional>
 The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
mute boolean Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
property_groups Array.<FilePropertiesPropertyGroup> <optional>
 List of custom properties to add to file.
strict_conflict boolean Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesUploadWriteFailed <optional>
 Available if .tag is path. Unable to save the uploaded contents to a file.
properties_error FilePropertiesInvalidPropertyGroupError <optional>
 Available if .tag is properties_error. The supplied property group is invalid. The file has uploaded without property groups.
.tag 'path' | 'properties_error' | 'payload_too_large' | 'content_hash_mismatch' | 'other' Tag identifying the union variant.

FilesUploadSessionAppendArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
cursor FilesUploadSessionCursor Contains the upload session ID and the offset.
close boolean If true, the current session will be closed, at which point you won't be able to call upload_session/append:2 anymore with the current session.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadSessionAppendError

Type:
  • Object
Properties:
Name Type Argument Description
incorrect_offset FilesUploadSessionOffsetError <optional>
 Available if .tag is incorrect_offset. The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.
.tag 'not_found' | 'incorrect_offset' | 'closed' | 'not_closed' | 'too_large' | 'concurrent_session_invalid_offset' | 'concurrent_session_invalid_data_size' | 'payload_too_large' | 'other' | 'content_hash_mismatch' Tag identifying the union variant.

FilesUploadSessionCursor

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
session_id string The upload session ID (returned by upload_session/start).
offset number Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error.

FilesUploadSessionFinishArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
cursor FilesUploadSessionCursor Contains the upload session ID and the offset.
commit FilesCommitInfo Contains the path and other optional modifiers for the commit.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadSessionFinishBatchArg

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesUploadSessionFinishArg> Commit information for each file in the batch.

FilesUploadSessionFinishBatchJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete FilesUploadSessionFinishBatchResult <optional>
 Available if .tag is complete. The :route:`upload_session/finish_batch` has finished.
.tag 'in_progress' | 'complete' Tag identifying the union variant.

FilesUploadSessionFinishBatchLaunch

Result returned by upload_session/finish_batch that may either launch an asynchronous job or complete synchronously.
Type:
  • Object
Properties:
Name Type Argument Description
async_job_id string <optional>
 Available if .tag is async_job_id. This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete FilesUploadSessionFinishBatchResult <optional>
 Available if .tag is complete.
.tag 'async_job_id' | 'complete' | 'other' Tag identifying the union variant.

FilesUploadSessionFinishBatchResult

Type:
  • Object
Properties:
Name Type Description
entries Array.<FilesUploadSessionFinishBatchResultEntry> Each entry in UploadSessionFinishBatchArg.entries will appear at the same position inside UploadSessionFinishBatchResult.entries.

FilesUploadSessionFinishBatchResultEntry

Type:
  • Object
Properties:
Name Type Argument Description
success FilesFileMetadata <optional>
 Available if .tag is success.
failure FilesUploadSessionFinishError <optional>
 Available if .tag is failure.
.tag 'success' | 'failure' Tag identifying the union variant.

FilesUploadSessionFinishError

Type:
  • Object
Properties:
Name Type Argument Description
lookup_failed FilesUploadSessionLookupError <optional>
 Available if .tag is lookup_failed. The session arguments are incorrect; the value explains the reason.
path FilesWriteError <optional>
 Available if .tag is path. Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset.
properties_error FilePropertiesInvalidPropertyGroupError <optional>
 Available if .tag is properties_error. The supplied property group is invalid. The file has uploaded without property groups.
.tag 'lookup_failed' | 'path' | 'properties_error' | 'too_many_shared_folder_targets' | 'too_many_write_operations' | 'concurrent_session_data_not_allowed' | 'concurrent_session_not_closed' | 'concurrent_session_missing_data' | 'payload_too_large' | 'content_hash_mismatch' | 'other' Tag identifying the union variant.

FilesUploadSessionLookupError

Type:
  • Object
Properties:
Name Type Argument Description
incorrect_offset FilesUploadSessionOffsetError <optional>
 Available if .tag is incorrect_offset. The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.
.tag 'not_found' | 'incorrect_offset' | 'closed' | 'not_closed' | 'too_large' | 'concurrent_session_invalid_offset' | 'concurrent_session_invalid_data_size' | 'payload_too_large' | 'other' Tag identifying the union variant.

FilesUploadSessionOffsetError

Type:
  • Object
Properties:
Name Type Description
correct_offset number The offset up to which data has been collected.

FilesUploadSessionStartArg

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
close boolean If true, the current session will be closed, at which point you won't be able to call upload_session/append:2 anymore with the current session.
session_type FilesUploadSessionType <optional>
 Type of upload session you want to start. If not specified, default is UploadSessionType.sequential.
content_hash string <optional>
 A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

FilesUploadSessionStartBatchArg

Type:
  • Object
Properties:
Name Type Argument Description
num_sessions number The number of upload sessions to start.
session_type FilesUploadSessionType <optional>
 Type of upload session you want to start. If not specified, default is UploadSessionType.sequential.

FilesUploadSessionStartBatchResult

Type:
  • Object
Properties:
Name Type Description
session_ids Array.<string> A List of unique identifiers for the upload session. Pass each session_id to upload_session/append:2 and upload_session/finish.

FilesUploadSessionStartError

Type:
  • Object
Properties:
Name Type Description
.tag 'concurrent_session_data_not_allowed' | 'concurrent_session_close_not_allowed' | 'payload_too_large' | 'content_hash_mismatch' | 'other' Tag identifying the union variant.

FilesUploadSessionStartResult

Type:
  • Object
Properties:
Name Type Description
session_id string A unique identifier for the upload session. Pass this to upload_session/append:2 and upload_session/finish.

FilesUploadSessionType

Type:
  • Object
Properties:
Name Type Description
.tag 'sequential' | 'concurrent' | 'other' Tag identifying the union variant.

FilesUploadWriteFailed

Type:
  • Object
Properties:
Name Type Description
reason FilesWriteError The reason why the file couldn't be saved.
upload_session_id string The upload session ID; data has already been uploaded to the corresponding upload session and this ID may be used to retry the commit with upload_session/finish.

FilesUserGeneratedTag

Type:
  • Object
Properties:
Name Type Description
tag_text string

FilesVideoMetadata

Metadata for a video.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'video' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
dimensions FilesDimensions <optional>
 Dimension of the photo/video.
location FilesGpsCoordinates <optional>
 The GPS coordinate of the photo/video.
time_taken Timestamp <optional>
 The timestamp when the photo/video is taken.
duration number <optional>
 The duration of the video in milliseconds.

FilesWriteConflictError

Type:
  • Object
Properties:
Name Type Description
.tag 'file' | 'folder' | 'file_ancestor' | 'other' Tag identifying the union variant.

FilesWriteError

Type:
  • Object
Properties:
Name Type Argument Description
malformed_path string <optional>
 Available if .tag is malformed_path. The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information.
conflict FilesWriteConflictError <optional>
 Available if .tag is conflict. Couldn't write to the target path because there was something in the way.
.tag 'malformed_path' | 'conflict' | 'no_write_permission' | 'insufficient_space' | 'disallowed_name' | 'team_folder' | 'operation_suppressed' | 'too_many_write_operations' | 'other' Tag identifying the union variant.

FilesWriteMode

Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is. In some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict. The conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.
Type:
  • Object
Properties:
Name Type Argument Description
update string <optional>
 Available if .tag is update. Overwrite if the given "rev" matches the existing file's "rev". The supplied value should be the latest known "rev" of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given "rev" matches the existing file's current "rev" on the Dropbox servers. The autorename strategy is to append the string "conflicted copy" to the file name. For example, "document.txt" might become "document (conflicted copy).txt" or "document (Panda's conflicted copy).txt".
.tag 'add' | 'overwrite' | 'update' Tag identifying the union variant.

OpenidOpenIdError

Type:
  • Object
Properties:
Name Type Description
.tag 'incorrect_openid_scopes' | 'other' Tag identifying the union variant.

OpenidUserInfoArgs

No Parameters
Type:
  • Object

OpenidUserInfoError

Type:
  • Object
Properties:
Name Type Argument Description
openid_error OpenidOpenIdError <optional>
 Available if .tag is openid_error.
.tag 'openid_error' | 'other' Tag identifying the union variant.

OpenidUserInfoResult

Type:
  • Object
Properties:
Name Type Argument Description
family_name string <optional>
 Last name of user.
given_name string <optional>
 First name of user.
email string <optional>
 Email address of user.
email_verified boolean <optional>
 If user is email verified.
iss string Issuer of token (in this case Dropbox).
sub string An identifier for the user. This is the Dropbox account_id, a string value such as dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc.

PaperAddMember

Type:
  • Object
Properties:
Name Type Description
member SharingMemberSelector User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
permission_level PaperPaperDocPermissionLevel Permission for the user.

PaperAddPaperDocUser

Type:
  • Object
Properties:
Name Type Argument Description
doc_id string The Paper doc ID.
members Array.<PaperAddMember> User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
custom_message string <optional>
 A personal message that will be emailed to each successfully added member.
quiet boolean Clients should set this to true if no email message shall be sent to added users.

PaperAddPaperDocUserMemberResult

Per-member result for docs/users/add.
Type:
  • Object
Properties:
Name Type Description
member SharingMemberSelector One of specified input members.
result PaperAddPaperDocUserResult The outcome of the action on this member.

PaperAddPaperDocUserResult

Type:
  • Object
Properties:
Name Type Description
.tag 'success' | 'unknown_error' | 'sharing_outside_team_disabled' | 'daily_limit_reached' | 'user_is_owner' | 'failed_user_data_retrieval' | 'permission_already_granted' | 'other' Tag identifying the union variant.

PaperCursor

Type:
  • Object
Properties:
Name Type Argument Description
value string The actual cursor value.
expiration Timestamp <optional>
 Expiration time of value. Some cursors might have expiration time assigned. This is a UTC value after which the cursor is no longer valid and the API starts returning an error. If cursor expires a new one needs to be obtained and pagination needs to be restarted. Some cursors might be short-lived some cursors might be long-lived. This really depends on the sorting type and order, e.g.: 1. on one hand, listing docs created by the user, sorted by the created time ascending will have undefinite expiration because the results cannot change while the iteration is happening. This cursor would be suitable for long term polling. 2. on the other hand, listing docs sorted by the last modified time will have a very short expiration as docs do get modified very often and the modified time can be changed while the iteration is happening thus altering the results.

PaperDocLookupError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'doc_not_found' Tag identifying the union variant.

PaperDocSubscriptionLevel

The subscription level of a Paper doc.
Type:
  • Object
Properties:
Name Type Description
.tag 'default' | 'ignore' | 'every' | 'no_email' Tag identifying the union variant.

PaperExportFormat

The desired export format of the Paper doc.
Type:
  • Object
Properties:
Name Type Description
.tag 'html' | 'markdown' | 'other' Tag identifying the union variant.

PaperFolder

Data structure representing a Paper folder.
Type:
  • Object
Properties:
Name Type Description
id string Paper folder ID. This ID uniquely identifies the folder.
name string Paper folder name.

PaperFoldersContainingPaperDoc

Metadata about Paper folders containing the specififed Paper doc.
Type:
  • Object
Properties:
Name Type Argument Description
folder_sharing_policy_type PaperFolderSharingPolicyType <optional>
 The sharing policy of the folder containing the Paper doc.
folders Array.<PaperFolder> <optional>
 The folder path. If present the first folder is the root folder.

PaperFolderSharingPolicyType

The sharing policy of a Paper folder. The sharing policy of subfolders is inherited from the root folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'team' | 'invite_only' Tag identifying the union variant.

PaperFolderSubscriptionLevel

The subscription level of a Paper folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'none' | 'activity_only' | 'daily_emails' | 'weekly_emails' Tag identifying the union variant.

PaperImportFormat

The import format of the incoming data.
Type:
  • Object
Properties:
Name Type Description
.tag 'html' | 'markdown' | 'plain_text' | 'other' Tag identifying the union variant.

PaperInviteeInfoWithPermissionLevel

Type:
  • Object
Properties:
Name Type Description
invitee SharingInviteeInfo Email address invited to the Paper doc.
permission_level PaperPaperDocPermissionLevel Permission level for the invitee.

PaperListDocsCursorError

Type:
  • Object
Properties:
Name Type Argument Description
cursor_error PaperPaperApiCursorError <optional>
 Available if .tag is cursor_error.
.tag 'cursor_error' | 'other' Tag identifying the union variant.

PaperListPaperDocsArgs

Type:
  • Object
Properties:
Name Type Description
filter_by PaperListPaperDocsFilterBy Allows user to specify how the Paper docs should be filtered.
sort_by PaperListPaperDocsSortBy Allows user to specify how the Paper docs should be sorted.
sort_order PaperListPaperDocsSortOrder Allows user to specify the sort order of the result.
limit number Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

PaperListPaperDocsContinueArgs

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor obtained from docs/list or docs/list/continue. Allows for pagination.

PaperListPaperDocsFilterBy

Type:
  • Object
Properties:
Name Type Description
.tag 'docs_accessed' | 'docs_created' | 'other' Tag identifying the union variant.

PaperListPaperDocsResponse

Type:
  • Object
Properties:
Name Type Description
doc_ids Array.<Object> The list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods. The list is sorted in the order specified by the initial call to docs/list.
cursor PaperCursor Pass the cursor into docs/list/continue to paginate through all files. The cursor preserves all properties as specified in the original call to docs/list.
has_more boolean Will be set to True if a subsequent call with the provided cursor to docs/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/list/continue.

PaperListPaperDocsSortBy

Type:
  • Object
Properties:
Name Type Description
.tag 'accessed' | 'modified' | 'created' | 'other' Tag identifying the union variant.

PaperListPaperDocsSortOrder

Type:
  • Object
Properties:
Name Type Description
.tag 'ascending' | 'descending' | 'other' Tag identifying the union variant.

PaperListUsersCursorError

Type:
  • Object
Properties:
Name Type Argument Description
cursor_error PaperPaperApiCursorError <optional>
 Available if .tag is cursor_error.
.tag 'insufficient_permissions' | 'other' | 'doc_not_found' | 'cursor_error' Tag identifying the union variant.

PaperListUsersOnFolderArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
limit number Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

PaperListUsersOnFolderContinueArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
cursor string The cursor obtained from docs/folder_users/list or docs/folder_users/list/continue. Allows for pagination.

PaperListUsersOnFolderResponse

Type:
  • Object
Properties:
Name Type Description
invitees Array.<SharingInviteeInfo> List of email addresses that are invited on the Paper folder.
users Array.<SharingUserInfo> List of users that are invited on the Paper folder.
cursor PaperCursor Pass the cursor into docs/folder_users/list/continue to paginate through all users. The cursor preserves all properties as specified in the original call to docs/folder_users/list.
has_more boolean Will be set to True if a subsequent call with the provided cursor to docs/folder_users/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/folder_users/list/continue.

PaperListUsersOnPaperDocArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
limit number Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
filter_by PaperUserOnPaperDocFilter Specify this attribute if you want to obtain users that have already accessed the Paper doc.

PaperListUsersOnPaperDocContinueArgs

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
cursor string The cursor obtained from docs/users/list or docs/users/list/continue. Allows for pagination.

PaperListUsersOnPaperDocResponse

Type:
  • Object
Properties:
Name Type Description
invitees Array.<PaperInviteeInfoWithPermissionLevel> List of email addresses with their respective permission levels that are invited on the Paper doc.
users Array.<PaperUserInfoWithPermissionLevel> List of users with their respective permission levels that are invited on the Paper folder.
doc_owner SharingUserInfo The Paper doc owner. This field is populated on every single response.
cursor PaperCursor Pass the cursor into docs/users/list/continue to paginate through all users. The cursor preserves all properties as specified in the original call to docs/users/list.
has_more boolean Will be set to True if a subsequent call with the provided cursor to docs/users/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/users/list/continue.

PaperPaperApiBaseError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' Tag identifying the union variant.

PaperPaperApiCursorError

Type:
  • Object
Properties:
Name Type Description
.tag 'expired_cursor' | 'invalid_cursor' | 'wrong_user_in_cursor' | 'reset' | 'other' Tag identifying the union variant.

PaperPaperDocCreateArgs

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
import_format PaperImportFormat The format of provided data.
parent_folder_id string <optional>
 The Paper folder ID where the Paper document should be created. The API user has to have write access to this folder or error is thrown.

PaperPaperDocCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'content_malformed' | 'folder_not_found' | 'doc_length_exceeded' | 'image_size_exceeded' Tag identifying the union variant.

PaperPaperDocCreateUpdateResult

Type:
  • Object
Properties:
Name Type Description
doc_id string Doc ID of the newly created doc.
revision number The Paper doc revision. Simply an ever increasing number.
title string The Paper doc title.

PaperPaperDocExport

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
export_format PaperExportFormat

PaperPaperDocExportResult

Type:
  • Object
Properties:
Name Type Description
owner string The Paper doc owner's email address.
title string The Paper doc title.
revision number The Paper doc revision. Simply an ever increasing number.
mime_type string MIME type of the export. This corresponds to ExportFormat specified in the request.

PaperPaperDocPermissionLevel

Type:
  • Object
Properties:
Name Type Description
.tag 'edit' | 'view_and_comment' | 'other' Tag identifying the union variant.

PaperPaperDocSharingPolicy

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
sharing_policy PaperSharingPolicy The default sharing policy to be set for the Paper doc.

PaperPaperDocUpdateArgs

Type:
  • Object
Properties:
Name Type Argument Description
contents Object <optional>
 The file contents to be uploaded.
doc_id string The Paper doc ID.
doc_update_policy PaperPaperDocUpdatePolicy The policy used for the current update call.
revision number The latest doc revision. This value must match the head revision or an error code will be returned. This is to prevent colliding writes.
import_format PaperImportFormat The format of provided data.

PaperPaperDocUpdateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'doc_not_found' | 'content_malformed' | 'revision_mismatch' | 'doc_length_exceeded' | 'image_size_exceeded' | 'doc_archived' | 'doc_deleted' Tag identifying the union variant.

PaperPaperDocUpdatePolicy

Type:
  • Object
Properties:
Name Type Description
.tag 'append' | 'prepend' | 'overwrite_all' | 'other' Tag identifying the union variant.

PaperPaperFolderCreateArg

Type:
  • Object
Properties:
Name Type Argument Description
name string The name of the new Paper folder.
parent_folder_id string <optional>
 The encrypted Paper folder Id where the new Paper folder should be created. The API user has to have write access to this folder or error is thrown. If not supplied, the new folder will be created at top level.
is_team_folder boolean <optional>
 Whether the folder to be created should be a team folder. This value will be ignored if parent_folder_id is supplied, as the new folder will inherit the type (private or team folder) from its parent. We will by default create a top-level private folder if both parent_folder_id and is_team_folder are not supplied.

PaperPaperFolderCreateError

Type:
  • Object
Properties:
Name Type Description
.tag 'insufficient_permissions' | 'other' | 'folder_not_found' | 'invalid_folder_id' Tag identifying the union variant.

PaperPaperFolderCreateResult

Type:
  • Object
Properties:
Name Type Description
folder_id string Folder ID of the newly created folder.

PaperRefPaperDoc

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.

PaperRemovePaperDocUser

Type:
  • Object
Properties:
Name Type Description
doc_id string The Paper doc ID.
member SharingMemberSelector User which should be removed from the Paper doc. Specify only email address or Dropbox account ID.

PaperSharingPolicy

Sharing policy of Paper doc.
Type:
  • Object
Properties:
Name Type Argument Description
public_sharing_policy PaperSharingPublicPolicyType <optional>
 This value applies to the non-team members.
team_sharing_policy PaperSharingTeamPolicyType <optional>
 This value applies to the team members only. The value is null for all personal accounts.

PaperSharingPublicPolicyType

Type:
  • Object
Properties:
Name Type Description
.tag 'people_with_link_can_edit' | 'people_with_link_can_view_and_comment' | 'invite_only' | 'disabled' Tag identifying the union variant.

PaperSharingTeamPolicyType

The sharing policy type of the Paper doc.
Type:
  • Object
Properties:
Name Type Description
.tag 'people_with_link_can_edit' | 'people_with_link_can_view_and_comment' | 'invite_only' Tag identifying the union variant.

PaperUserInfoWithPermissionLevel

Type:
  • Object
Properties:
Name Type Description
user SharingUserInfo User shared on the Paper doc.
permission_level PaperPaperDocPermissionLevel Permission level for the user.

PaperUserOnPaperDocFilter

Type:
  • Object
Properties:
Name Type Description
.tag 'visited' | 'shared' | 'other' Tag identifying the union variant.

SecondaryEmailsSecondaryEmail

Type:
  • Object
Properties:
Name Type Description
email string Secondary email address.
is_verified boolean Whether or not the secondary email address is verified to be owned by a user.

SeenStatePlatformType

Possible platforms on which a user may view content.
Type:
  • Object
Properties:
Name Type Description
.tag 'web' | 'desktop' | 'mobile_ios' | 'mobile_android' | 'api' | 'unknown' | 'mobile' | 'other' Tag identifying the union variant.

SharingAccessInheritance

Information about the inheritance policy of a shared folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'inherit' | 'no_inherit' | 'other' Tag identifying the union variant.

SharingAccessLevel

Defines the access levels for collaborators.
Type:
  • Object
Properties:
Name Type Description
.tag 'owner' | 'editor' | 'viewer' | 'viewer_no_comment' | 'traverse' | 'other' Tag identifying the union variant.

SharingAclUpdatePolicy

Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.
Type:
  • Object
Properties:
Name Type Description
.tag 'owner' | 'editors' | 'other' Tag identifying the union variant.

SharingAddFileMemberArgs

Arguments for add_file_member.
Type:
  • Object
Properties:
Name Type Argument Description
file string File to which to add members.
members Array.<SharingMemberSelector> Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user's main account email.
custom_message string <optional>
 Message to send to added members in their invitation.
quiet boolean Whether added members should be notified via email and device notifications of their invitation.
access_level SharingAccessLevel AccessLevel union object, describing what access level we want to give new members.
add_message_as_comment boolean If the custom message should be added as a comment on the file.

SharingAddFileMemberError

Errors for add_file_member.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'rate_limit' | 'invalid_comment' | 'other' Tag identifying the union variant.

SharingAddFolderMemberArg

Type:
  • Object
Properties:
Name Type Argument Description
shared_folder_id string The ID for the shared folder.
members Array.<SharingAddMember> The intended list of members to add. Added members will receive invites to join the shared folder.
quiet boolean Whether added members should be notified via email and device notifications of their invite.
custom_message string <optional>
 Optional message to display to added members in their invitation.

SharingAddFolderMemberError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error. Unable to access shared folder.
bad_member SharingAddMemberSelectorError <optional>
 Available if .tag is bad_member. :field:`AddFolderMemberArg.members` contains a bad invitation recipient.
too_many_members number <optional>
 Available if .tag is too_many_members. The value is the member limit that was reached.
too_many_pending_invites number <optional>
 Available if .tag is too_many_pending_invites. The value is the pending invite limit that was reached.
.tag 'access_error' | 'email_unverified' | 'banned_member' | 'bad_member' | 'cant_share_outside_team' | 'too_many_members' | 'too_many_pending_invites' | 'rate_limit' | 'too_many_invitees' | 'insufficient_plan' | 'team_folder' | 'no_permission' | 'invalid_shared_folder' | 'other' Tag identifying the union variant.

SharingAddMember

The member and type of access the member should have when added to a shared folder.
Type:
  • Object
Properties:
Name Type Description
member SharingMemberSelector The member to add to the shared folder.
access_level SharingAccessLevel The access level to grant member to the shared folder. AccessLevel.owner is disallowed.

SharingAddMemberSelectorError

Type:
  • Object
Properties:
Name Type Argument Description
invalid_dropbox_id string <optional>
 Available if .tag is invalid_dropbox_id. The value is the ID that could not be identified.
invalid_email string <optional>
 Available if .tag is invalid_email. The value is the e-email address that is malformed.
unverified_dropbox_id string <optional>
 Available if .tag is unverified_dropbox_id. The value is the ID of the Dropbox user with an unverified email address. Invite unverified users by email address instead of by their Dropbox ID.
.tag 'automatic_group' | 'invalid_dropbox_id' | 'invalid_email' | 'unverified_dropbox_id' | 'group_deleted' | 'group_not_on_team' | 'other' Tag identifying the union variant.

SharingAlphaResolvedVisibility

check documentation for ResolvedVisibility.
Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team_only' | 'password' | 'team_and_password' | 'shared_folder_only' | 'no_one' | 'only_you' | 'other' Tag identifying the union variant.

SharingAudienceExceptionContentInfo

Information about the content that has a link audience different than that of this folder.
Type:
  • Object
Properties:
Name Type Description
name string The name of the content, which is either a file or a folder.

SharingAudienceExceptions

The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.
Type:
  • Object
Properties:
Name Type Description
count number
exceptions Array.<SharingAudienceExceptionContentInfo> A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.

SharingAudienceRestrictingSharedFolder

Information about the shared folder that prevents the link audience for this link from being more restrictive.
Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID of the shared folder.
name string The name of the shared folder.
audience SharingLinkAudience The link audience of the shared folder.

SharingCollectionLinkMetadata

Metadata for a collection-based shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'collection' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
visibility SharingVisibility Who can access the link.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.

SharingCreateSharedLinkArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path to share.
short_url boolean
pending_upload SharingPendingUploadMode <optional>
 If it's okay to share a path that does not yet exist, set this to either PendingUploadMode.file or PendingUploadMode.folder to indicate whether to assume it's a file or folder.

SharingCreateSharedLinkError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

SharingCreateSharedLinkWithSettingsArg

Type:
  • Object
Properties:
Name Type Argument Description
path string The path to be shared by the shared link.
settings SharingSharedLinkSettings <optional>
 The requested settings for the newly created shared link.

SharingCreateSharedLinkWithSettingsError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
shared_link_already_exists SharingSharedLinkAlreadyExistsMetadata <optional>
 Available if .tag is shared_link_already_exists. The shared link already exists. You can call :route:`list_shared_links` to get the existing link, or use the provided metadata if it is returned.
settings_error SharingSharedLinkSettingsError <optional>
 Available if .tag is settings_error. There is an error with the given settings.
.tag 'path' | 'email_not_verified' | 'shared_link_already_exists' | 'settings_error' | 'access_denied' Tag identifying the union variant.

SharingExpectedSharedContentLinkMetadata

The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.
Type:
  • Object
Properties:
Name Type Argument Description
audience_options Array.<SharingLinkAudience> The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.
current_audience SharingLinkAudience The current audience of the link.
link_permissions Array.<SharingLinkPermission> A list of permissions for actions you can perform on the link.
password_protected boolean Whether the link is protected by a password.
access_level SharingAccessLevel <optional>
 The access level on the link for this file.
audience_restricting_shared_folder SharingAudienceRestrictingSharedFolder <optional>
 The shared folder that prevents the link audience for this link from being more restrictive.
expiry Timestamp <optional>
 Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.

SharingFileAction

Sharing actions that may be taken on files.
Type:
  • Object
Properties:
Name Type Description
.tag 'disable_viewer_info' | 'edit_contents' | 'enable_viewer_info' | 'invite_viewer' | 'invite_viewer_no_comment' | 'invite_editor' | 'unshare' | 'relinquish_membership' | 'share_link' | 'create_link' | 'create_view_link' | 'create_edit_link' | 'other' Tag identifying the union variant.

SharingFileErrorResult

Type:
  • Object
Properties:
Name Type Argument Description
file_not_found_error string <optional>
 Available if .tag is file_not_found_error. File specified by id was not found.
invalid_file_action_error string <optional>
 Available if .tag is invalid_file_action_error. User does not have permission to take the specified action on the file.
permission_denied_error string <optional>
 Available if .tag is permission_denied_error. User does not have permission to access file specified by file.Id.
.tag 'file_not_found_error' | 'invalid_file_action_error' | 'permission_denied_error' | 'other' Tag identifying the union variant.

SharingFileLinkMetadata

The metadata of a file shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'file' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
name string The linked file name (including extension). This never contains a slash.
link_permissions SharingLinkPermissions The link's access permissions.
client_modified Timestamp The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.
server_modified Timestamp The last time the file was modified on Dropbox.
rev string A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
size number The file size in bytes.
id string <optional>
 A unique identifier for the linked file.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox.
team_member_info SharingTeamMemberInfo <optional>
 The team membership information of the link's owner. This field will only be present if the link's owner is a team member.
content_owner_team_info UsersTeam <optional>
 The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team.

SharingFileMemberActionError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error. Specified file was invalid or user does not have access.
no_explicit_access SharingMemberAccessLevelResult <optional>
 Available if .tag is no_explicit_access. The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.
.tag 'invalid_member' | 'no_permission' | 'access_error' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingFileMemberActionIndividualResult

Type:
  • Object
Properties:
Name Type Argument Description
success SharingAccessLevel <optional>
 Available if .tag is success. Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder.
member_error SharingFileMemberActionError <optional>
 Available if .tag is member_error. User was not able to perform this action.
.tag 'success' | 'member_error' Tag identifying the union variant.

SharingFileMemberActionResult

Per-member result for add_file_member.
Type:
  • Object
Properties:
Name Type Argument Description
member SharingMemberSelector One of specified input members.
result SharingFileMemberActionIndividualResult The outcome of the action on this member.
sckey_sha1 string <optional>
 The SHA-1 encrypted shared content key.
invitation_signature Array.<string> <optional>
 The sharing sender-recipient invitation signatures for the input member_id. A member_id can be a group and thus have multiple users and multiple invitation signatures.

SharingFileMemberRemoveActionResult

Type:
  • Object
Properties:
Name Type Argument Description
success SharingMemberAccessLevelResult <optional>
 Available if .tag is success. Member was successfully removed from this file.
member_error SharingFileMemberActionError <optional>
 Available if .tag is member_error. User was not able to remove this member.
.tag 'success' | 'member_error' | 'other' Tag identifying the union variant.

SharingFilePermission

Whether the user is allowed to take the sharing action on the file.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingFileAction The action that the user may wish to take on the file.
allow boolean True if the user is allowed to take the action.
reason SharingPermissionDeniedReason <optional>
 The reason why the user is denied the permission. Not present if the action is allowed.

SharingFolderAction

Actions that may be taken on shared folders.
Type:
  • Object
Properties:
Name Type Description
.tag 'change_options' | 'disable_viewer_info' | 'edit_contents' | 'enable_viewer_info' | 'invite_editor' | 'invite_viewer' | 'invite_viewer_no_comment' | 'relinquish_membership' | 'unmount' | 'unshare' | 'leave_a_copy' | 'share_link' | 'create_link' | 'set_access_inheritance' | 'other' Tag identifying the union variant.

SharingFolderLinkMetadata

The metadata of a folder shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'folder' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
name string The linked file name (including extension). This never contains a slash.
link_permissions SharingLinkPermissions The link's access permissions.
id string <optional>
 A unique identifier for the linked file.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.
path_lower string <optional>
 The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox.
team_member_info SharingTeamMemberInfo <optional>
 The team membership information of the link's owner. This field will only be present if the link's owner is a team member.
content_owner_team_info UsersTeam <optional>
 The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team.

SharingFolderPermission

Whether the user is allowed to take the action on the shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingFolderAction The action that the user may wish to take on the folder.
allow boolean True if the user is allowed to take the action.
reason SharingPermissionDeniedReason <optional>
 The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available.

SharingFolderPolicy

A set of policies governing membership and privileges for a shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
acl_update_policy SharingAclUpdatePolicy Who can add and remove members from this shared folder.
shared_link_policy SharingSharedLinkPolicy Who links can be shared with.
member_policy SharingMemberPolicy <optional>
 Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team.
resolved_member_policy SharingMemberPolicy <optional>
 Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team.
viewer_info_policy SharingViewerInfoPolicy <optional>
 Who can enable/disable viewer info for this shared folder.

SharingGetFileMetadataArg

Arguments of get_file_metadata.
Type:
  • Object
Properties:
Name Type Argument Description
file string The file to query.
actions Array.<SharingFileAction> <optional>
 A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

SharingGetFileMetadataBatchArg

Arguments of get_file_metadata/batch.
Type:
  • Object
Properties:
Name Type Argument Description
files Array.<Object> The files to query.
actions Array.<SharingFileAction> <optional>
 A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

SharingGetFileMetadataBatchResult

Per file results of get_file_metadata/batch.
Type:
  • Object
Properties:
Name Type Description
file string This is the input file identifier corresponding to one of GetFileMetadataBatchArg.files.
result SharingGetFileMetadataIndividualResult The result for this particular file.

SharingGetFileMetadataError

Error result for get_file_metadata.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'other' Tag identifying the union variant.

SharingGetFileMetadataIndividualResult

Type:
  • Object
Properties:
Name Type Argument Description
metadata SharingSharedFileMetadata <optional>
 Available if .tag is metadata. The result for this file if it was successful.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error. The result for this file if it was an error.
.tag 'metadata' | 'access_error' | 'other' Tag identifying the union variant.

SharingGetMetadataArgs

Type:
  • Object
Properties:
Name Type Argument Description
shared_folder_id string The ID for the shared folder.
actions Array.<SharingFolderAction> <optional>
 A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

SharingGetSharedLinkFileError

Type:
  • Object
Properties:
Name Type Description
.tag 'shared_link_not_found' | 'shared_link_access_denied' | 'unsupported_link_type' | 'other' | 'shared_link_is_directory' Tag identifying the union variant.

SharingGetSharedLinkMetadataArg

Type:
  • Object
Properties:
Name Type Argument Description
url string URL of the shared link.
path string <optional>
 If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
link_password string <optional>
 If the shared link has a password, this parameter can be used.

SharingGetSharedLinksArg

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 See get_shared_links description.

SharingGetSharedLinksError

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 Available if .tag is path.
.tag 'path' | 'other' Tag identifying the union variant.

SharingGetSharedLinksResult

Type:
  • Object
Properties:
Name Type Description
links Array.<(SharingPathLinkMetadata|SharingCollectionLinkMetadata|SharingLinkMetadata)> Shared links applicable to the path argument.

SharingGroupInfo

The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
group_name string
group_id string
group_management_type TeamCommonGroupManagementType Who is allowed to manage the group.
group_type TeamCommonGroupType The type of group.
is_member boolean If the current user is a member of the group.
is_owner boolean If the current user is an owner of the group.
same_team boolean If the group is owned by the current user's team.
group_external_id string <optional>
 External ID of group. This is an arbitrary ID that an admin can attach to a group.
member_count number <optional>
 The number of members in the group.

SharingGroupMembershipInfo

The information about a group member of the shared content.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
group SharingGroupInfo The information about the membership group.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.

SharingInsufficientPlan

Type:
  • Object
Properties:
Name Type Argument Description
message string A message to tell the user to upgrade in order to support expected action.
upsell_url string <optional>
 A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade.

SharingInsufficientQuotaAmounts

Type:
  • Object
Properties:
Name Type Description
space_needed number The amount of space needed to add the item (the size of the item).
space_shortage number The amount of extra space needed to add the item.
space_left number The amount of space left in the user's Dropbox, less than space_needed.

SharingInviteeInfo

Information about the recipient of a shared content invitation.
Type:
  • Object
Properties:
Name Type Argument Description
email string <optional>
 Available if .tag is email. Email address of invited user.
.tag 'email' | 'other' Tag identifying the union variant.

SharingInviteeMembershipInfo

Information about an invited member of a shared content.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
invitee SharingInviteeInfo Recipient of the invitation.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.
user SharingUserInfo <optional>
 The user this invitation is tied to, if available.

SharingJobError

Error occurred while performing an asynchronous job from unshare_folder or remove_folder_member.
Type:
  • Object
Properties:
Name Type Argument Description
unshare_folder_error SharingUnshareFolderError <optional>
 Available if .tag is unshare_folder_error. Error occurred while performing :route:`unshare_folder` action.
remove_folder_member_error SharingRemoveFolderMemberError <optional>
 Available if .tag is remove_folder_member_error. Error occurred while performing :route:`remove_folder_member` action.
relinquish_folder_membership_error SharingRelinquishFolderMembershipError <optional>
 Available if .tag is relinquish_folder_membership_error. Error occurred while performing :route:`relinquish_folder_membership` action.
.tag 'unshare_folder_error' | 'remove_folder_member_error' | 'relinquish_folder_membership_error' | 'other' Tag identifying the union variant.

SharingJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
failed SharingJobError <optional>
 Available if .tag is failed. The asynchronous job returned an error.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

SharingLinkAccessLevel

Type:
  • Object
Properties:
Name Type Description
.tag 'viewer' | 'editor' | 'other' Tag identifying the union variant.

SharingLinkAction

Actions that can be performed on a link.
Type:
  • Object
Properties:
Name Type Description
.tag 'change_access_level' | 'change_audience' | 'remove_expiry' | 'remove_password' | 'set_expiry' | 'set_password' | 'other' Tag identifying the union variant.

SharingLinkAudience

Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team' | 'no_one' | 'password' | 'members' | 'other' Tag identifying the union variant.

SharingLinkAudienceDisallowedReason

check documentation for VisibilityPolicyDisallowedReason.
Type:
  • Object
Properties:
Name Type Description
.tag 'delete_and_recreate' | 'restricted_by_shared_folder' | 'restricted_by_team' | 'user_not_on_team' | 'user_account_type' | 'permission_denied' | 'other' Tag identifying the union variant.

SharingLinkAudienceOption

Type:
  • Object
Properties:
Name Type Argument Description
audience SharingLinkAudience Specifies who can access the link.
allowed boolean Whether the user calling this API can select this audience option.
disallowed_reason SharingLinkAudienceDisallowedReason <optional>
 If allowed is false, this will provide the reason that the user is not permitted to set the visibility to this policy.

SharingLinkExpiry

Type:
  • Object
Properties:
Name Type Argument Description
set_expiry Timestamp <optional>
 Available if .tag is set_expiry. Set a new expiry or change an existing expiry.
.tag 'remove_expiry' | 'set_expiry' | 'other' Tag identifying the union variant.

SharingLinkMetadata

Metadata for a shared link. This can be either a PathLinkMetadata or CollectionLinkMetadata.
Type:
  • Object
Properties:
Name Type Argument Description
.tag "path" | "collection" Tag identifying the subtype variant.
url string URL of the shared link.
visibility SharingVisibility Who can access the link.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.

SharingLinkPassword

Type:
  • Object
Properties:
Name Type Argument Description
set_password string <optional>
 Available if .tag is set_password. Set a new password or change an existing password.
.tag 'remove_password' | 'set_password' | 'other' Tag identifying the union variant.

SharingLinkPermission

Permissions for actions that can be performed on a link.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingLinkAction
allow boolean
reason SharingPermissionDeniedReason <optional>

SharingLinkPermissions

Type:
  • Object
Properties:
Name Type Argument Description
can_revoke boolean Whether the caller can revoke the shared link.
visibility_policies Array.<SharingVisibilityPolicy> A list of policies that the user might be able to set for the visibility.
can_set_expiry boolean Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry.
can_remove_expiry boolean Whether the user can remove the expiry of the link.
allow_download boolean Whether the link can be downloaded or not.
can_allow_download boolean Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link.
can_disallow_download boolean Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link.
allow_comments boolean Whether comments are enabled for the linked file. This takes the team commenting policy into account.
team_restricts_comments boolean Whether the team has disabled commenting globally.
resolved_visibility SharingResolvedVisibility <optional>
 The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead.
requested_visibility SharingRequestedVisibility <optional>
 The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in resolved_visibility. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience.
revoke_failure_reason SharingSharedLinkAccessFailureReason <optional>
 The failure reason for revoking the link. This field will only be present if the can_revoke is false.
effective_audience SharingLinkAudience <optional>
 The type of audience who can benefit from the access level specified by the `link_access_level` field.
link_access_level SharingLinkAccessLevel <optional>
 The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content.
audience_options Array.<SharingLinkAudienceOption> <optional>
 A list of link audience options the user might be able to set as the new audience.
can_set_password boolean <optional>
 Whether the user can set a password for the link.
can_remove_password boolean <optional>
 Whether the user can remove the password of the link.
require_password boolean <optional>
 Whether the user is required to provide a password to view the link.
can_use_extended_sharing_controls boolean <optional>
 Whether the user can use extended sharing controls, based on their account type.

SharingLinkSettings

Settings that apply to a link.
Type:
  • Object
Properties:
Name Type Argument Description
access_level SharingAccessLevel <optional>
 The access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'.
audience SharingLinkAudience <optional>
 The type of audience on the link for this file.
expiry SharingLinkExpiry <optional>
 An expiry timestamp to set on a link.
password SharingLinkPassword <optional>
 The password for the link.

SharingListFileMembersArg

Arguments for list_file_members.
Type:
  • Object
Properties:
Name Type Argument Description
file string The file for which you want to see members.
actions Array.<SharingMemberAction> <optional>
 The actions for which to return permissions on a member.
include_inherited boolean Whether to include members who only have access from a parent shared folder.
limit number Number of members to return max per query. Defaults to 100 if no limit is specified.

SharingListFileMembersBatchArg

Arguments for list_file_members/batch.
Type:
  • Object
Properties:
Name Type Description
files Array.<Object> Files for which to return members.
limit number Number of members to return max per query. Defaults to 10 if no limit is specified.

SharingListFileMembersBatchResult

Per-file result for list_file_members/batch.
Type:
  • Object
Properties:
Name Type Description
file string This is the input file identifier, whether an ID or a path.
result SharingListFileMembersIndividualResult The result for this particular file.

SharingListFileMembersContinueArg

Arguments for list_file_members/continue.
Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to list_file_members, list_file_members/continue, or list_file_members/batch.

SharingListFileMembersContinueError

Error for list_file_members/continue.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFileMembersCountResult

Type:
  • Object
Properties:
Name Type Description
members SharingSharedFileMembers A list of members on this file.
member_count number The number of members on this file. This does not include inherited members.

SharingListFileMembersError

Error for list_file_members.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'user_error' | 'access_error' | 'other' Tag identifying the union variant.

SharingListFileMembersIndividualResult

Type:
  • Object
Properties:
Name Type Argument Description
result SharingListFileMembersCountResult <optional>
 Available if .tag is result. The results of the query for this file if it was successful.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error. The result of the query for this file if it was an error.
.tag 'result' | 'access_error' | 'other' Tag identifying the union variant.

SharingListFilesArg

Arguments for list_received_files.
Type:
  • Object
Properties:
Name Type Argument Description
limit number Number of files to return max per query. Defaults to 100 if no limit is specified.
actions Array.<SharingFileAction> <optional>
 A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

SharingListFilesContinueArg

Arguments for list_received_files/continue.
Type:
  • Object
Properties:
Name Type Description
cursor string Cursor in ListFilesResult.cursor.

SharingListFilesContinueError

Error results for list_received_files/continue.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error. User account had a problem.
.tag 'user_error' | 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFilesResult

Success results for list_received_files.
Type:
  • Object
Properties:
Name Type Argument Description
entries Array.<SharingSharedFileMetadata> Information about the files shared with current user.
cursor string <optional>
 Cursor used to obtain additional shared files.

SharingListFolderMembersArgs

Type:
  • Object
Properties:
Name Type Argument Description
shared_folder_id string The ID for the shared folder.
actions Array.<SharingMemberAction> <optional>
 This is a list indicating whether each returned member will include a boolean value MemberPermission.allow that describes whether the current user can perform the MemberAction on the member.
limit number The maximum number of results that include members, groups and invitees to return per request.

SharingListFolderMembersContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by your last call to list_folder_members or list_folder_members/continue.

SharingListFolderMembersContinueError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFolderMembersCursorArg

Type:
  • Object
Properties:
Name Type Argument Description
actions Array.<SharingMemberAction> <optional>
 This is a list indicating whether each returned member will include a boolean value MemberPermission.allow that describes whether the current user can perform the MemberAction on the member.
limit number The maximum number of results that include members, groups and invitees to return per request.

SharingListFoldersArgs

Type:
  • Object
Properties:
Name Type Argument Description
limit number The maximum number of results to return per request.
actions Array.<SharingFolderAction> <optional>
 A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

SharingListFoldersContinueArg

Type:
  • Object
Properties:
Name Type Description
cursor string The cursor returned by the previous API call specified in the endpoint description.

SharingListFoldersContinueError

Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_cursor' | 'other' Tag identifying the union variant.

SharingListFoldersResult

Result for list_folders or list_mountable_folders, depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.path_lower.
Type:
  • Object
Properties:
Name Type Argument Description
entries Array.<SharingSharedFolderMetadata> List of all shared folders the authenticated user has access to.
cursor string <optional>
 Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either list_folders/continue or list_mountable_folders/continue) to list additional folders.

SharingListSharedLinksArg

Type:
  • Object
Properties:
Name Type Argument Description
path string <optional>
 See list_shared_links description.
cursor string <optional>
 The cursor returned by your last call to list_shared_links.
direct_only boolean <optional>
 See list_shared_links description.

SharingListSharedLinksError

Type:
  • Object
Properties:
Name Type Argument Description
path FilesLookupError <optional>
 Available if .tag is path.
.tag 'path' | 'reset' | 'other' Tag identifying the union variant.

SharingListSharedLinksResult

Type:
  • Object
Properties:
Name Type Argument Description
links Array.<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)> Shared links applicable to the path argument.
has_more boolean Is true if there are additional shared links that have not been returned yet. Pass the cursor into list_shared_links to retrieve them.
cursor string <optional>
 Pass the cursor into list_shared_links to obtain the additional links. Cursor is returned only if no path is given.

SharingMemberAccessLevelResult

Contains information about a member's access level to content after an operation.
Type:
  • Object
Properties:
Name Type Argument Description
access_level SharingAccessLevel <optional>
 The member still has this level of access to the content through a parent folder.
warning string <optional>
 A localized string with additional information about why the user has this access level to the content.
access_details Array.<SharingParentFolderAccessInfo> <optional>
 The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access.

SharingMemberAction

Actions that may be taken on members of a shared folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'leave_a_copy' | 'make_editor' | 'make_owner' | 'make_viewer' | 'make_viewer_no_comment' | 'remove' | 'other' Tag identifying the union variant.

SharingMemberPermission

Whether the user is allowed to take the action on the associated member.
Type:
  • Object
Properties:
Name Type Argument Description
action SharingMemberAction The action that the user may wish to take on the member.
allow boolean True if the user is allowed to take the action.
reason SharingPermissionDeniedReason <optional>
 The reason why the user is denied the permission. Not present if the action is allowed.

SharingMemberPolicy

Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.
Type:
  • Object
Properties:
Name Type Description
.tag 'team' | 'anyone' | 'other' Tag identifying the union variant.

SharingMemberSelector

Includes different ways to identify a member of a shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
dropbox_id string <optional>
 Available if .tag is dropbox_id. Dropbox account, team member, or group ID of member.
email string <optional>
 Available if .tag is email. Email address of member.
.tag 'dropbox_id' | 'email' | 'other' Tag identifying the union variant.

SharingMembershipInfo

The information about a member of the shared content.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
permissions Array.<SharingMemberPermission> <optional>
 The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
initials string <optional>
 Never set.
is_inherited boolean True if the member has access from a parent folder.

SharingModifySharedLinkSettingsArgs

Type:
  • Object
Properties:
Name Type Description
url string URL of the shared link to change its settings.
settings SharingSharedLinkSettings Set of settings for the shared link.
remove_expiration boolean If set to true, removes the expiration of the shared link.

SharingModifySharedLinkSettingsError

Type:
  • Object
Properties:
Name Type Argument Description
settings_error SharingSharedLinkSettingsError <optional>
 Available if .tag is settings_error. There is an error with the given settings.
.tag 'shared_link_not_found' | 'shared_link_access_denied' | 'unsupported_link_type' | 'other' | 'settings_error' | 'email_not_verified' Tag identifying the union variant.

SharingMountFolderArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID of the shared folder to mount.

SharingMountFolderError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
insufficient_quota SharingInsufficientQuotaAmounts <optional>
 Available if .tag is insufficient_quota. The current user does not have enough space to mount the shared folder.
.tag 'access_error' | 'inside_shared_folder' | 'insufficient_quota' | 'already_mounted' | 'no_permission' | 'not_mountable' | 'other' Tag identifying the union variant.

SharingParentFolderAccessInfo

Contains information about a parent folder that a member has access to.
Type:
  • Object
Properties:
Name Type Description
folder_name string Display name for the folder.
shared_folder_id string The identifier of the parent shared folder.
permissions Array.<SharingMemberPermission> The user's permissions for the parent shared folder.
path string The full path to the parent shared folder relative to the acting user's root.

SharingPathLinkMetadata

Metadata for a path-based shared link.
Type:
  • Object
Properties:
Name Type Argument Description
.tag 'path' <optional>
 Tag identifying this subtype variant. This field is only present when needed to discriminate between multiple possible subtypes.
url string URL of the shared link.
visibility SharingVisibility Who can access the link.
path string Path in user's Dropbox.
expires Timestamp <optional>
 Expiration time, if set. By default the link won't expire.

SharingPendingUploadMode

Flag to indicate pending upload default (for linking to not-yet-existing paths).
Type:
  • Object
Properties:
Name Type Description
.tag 'file' | 'folder' Tag identifying the union variant.

SharingPermissionDeniedReason

Possible reasons the user is denied a permission.
Type:
  • Object
Properties:
Name Type Argument Description
insufficient_plan SharingInsufficientPlan <optional>
 Available if .tag is insufficient_plan.
.tag 'user_not_same_team_as_owner' | 'user_not_allowed_by_owner' | 'target_is_indirect_member' | 'target_is_owner' | 'target_is_self' | 'target_not_active' | 'folder_is_limited_team_folder' | 'owner_not_on_team' | 'permission_denied' | 'restricted_by_team' | 'user_account_type' | 'user_not_on_team' | 'folder_is_inside_shared_folder' | 'restricted_by_parent_folder' | 'insufficient_plan' | 'other' Tag identifying the union variant.

SharingRelinquishFileMembershipArg

Type:
  • Object
Properties:
Name Type Description
file string The path or id for the file.

SharingRelinquishFileMembershipError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'group_access' | 'no_permission' | 'other' Tag identifying the union variant.

SharingRelinquishFolderMembershipArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
leave_a_copy boolean Keep a copy of the folder's contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder.

SharingRelinquishFolderMembershipError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
.tag 'access_error' | 'folder_owner' | 'mounted' | 'group_access' | 'team_folder' | 'no_permission' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingRemoveFileMemberArg

Arguments for remove_file_member_2.
Type:
  • Object
Properties:
Name Type Description
file string File from which to remove members.
member SharingMemberSelector Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address.

SharingRemoveFileMemberError

Errors for remove_file_member_2.
Type:
  • Object
Properties:
Name Type Argument Description
user_error SharingSharingUserError <optional>
 Available if .tag is user_error.
access_error SharingSharingFileAccessError <optional>
 Available if .tag is access_error.
no_explicit_access SharingMemberAccessLevelResult <optional>
 Available if .tag is no_explicit_access. This member does not have explicit access to the file and therefore cannot be removed. The return value is the access that a user might have to the file from a parent folder.
.tag 'user_error' | 'access_error' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingRemoveFolderMemberArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
member SharingMemberSelector The member to remove from the folder.
leave_a_copy boolean If true, the removed user will keep their copy of the folder after it's unshared, assuming it was mounted. Otherwise, it will be removed from their Dropbox. This must be set to false when removing a group, or when the folder is within a team folder or another shared folder.

SharingRemoveFolderMemberError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error.
member_error SharingSharedFolderMemberError <optional>
 Available if .tag is member_error.
.tag 'access_error' | 'member_error' | 'folder_owner' | 'group_access' | 'team_folder' | 'no_permission' | 'too_many_files' | 'other' Tag identifying the union variant.

SharingRemoveMemberJobStatus

Type:
  • Object
Properties:
Name Type Argument Description
complete SharingMemberAccessLevelResult <optional>
 Available if .tag is complete. Removing the folder member has finished. The value is information about whether the member has another form of access.
failed SharingRemoveFolderMemberError <optional>
 Available if .tag is failed.
.tag 'in_progress' | 'complete' | 'failed' Tag identifying the union variant.

SharingRequestedLinkAccessLevel

Type:
  • Object
Properties:
Name Type Description
.tag 'viewer' | 'editor' | 'max' | 'default' | 'other' Tag identifying the union variant.

SharingRequestedVisibility

The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the ResolvedVisibility for more info on the possible resolved visibility values of shared links.
Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team_only' | 'password' Tag identifying the union variant.

SharingResolvedVisibility

The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the RequestedVisibility for more info on the possible visibility values that can be set by the shared link's owner.
Type:
  • Object
Properties:
Name Type Description
.tag 'public' | 'team_only' | 'password' | 'team_and_password' | 'shared_folder_only' | 'no_one' | 'only_you' | 'other' Tag identifying the union variant.

SharingRevokeSharedLinkArg

Type:
  • Object
Properties:
Name Type Description
url string URL of the shared link.

SharingRevokeSharedLinkError

Type:
  • Object
Properties:
Name Type Description
.tag 'shared_link_not_found' | 'shared_link_access_denied' | 'unsupported_link_type' | 'other' | 'shared_link_malformed' Tag identifying the union variant.

SharingSetAccessInheritanceArg

Type:
  • Object
Properties:
Name Type Description
shared_folder_id string The ID for the shared folder.
access_inheritance SharingAccessInheritance The access inheritance settings for the folder.

SharingSetAccessInheritanceError

Type:
  • Object
Properties:
Name Type Argument Description
access_error SharingSharedFolderAccessError <optional>
 Available if .tag is access_error. Unable to access shared folder.
.tag 'access_error' | 'no_permission' | 'other' Tag identifying the union variant.

SharingSharedContentLinkMetadata

Metadata of a shared link for a file or folder.
Type:
  • Object
Properties:
Name Type Argument Description
audience_options Array.<SharingLinkAudience> The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.
current_audience SharingLinkAudience The current audience of the link.
link_permissions Array.<SharingLinkPermission> A list of permissions for actions you can perform on the link.
password_protected boolean Whether the link is protected by a password.
url string The URL of the link.
access_level SharingAccessLevel <optional>
 The access level on the link for this file.
audience_restricting_shared_folder SharingAudienceRestrictingSharedFolder <optional>
 The shared folder that prevents the link audience for this link from being more restrictive.
expiry Timestamp <optional>
 Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.
audience_exceptions SharingAudienceExceptions <optional>
 The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata.

SharingSharedContentLinkMetadataBase

Type:
  • Object
Properties:
Name Type Argument Description
audience_options Array.<SharingLinkAudience> The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.
current_audience SharingLinkAudience The current audience of the link.
link_permissions Array.<SharingLinkPermission> A list of permissions for actions you can perform on the link.
password_protected boolean Whether the link is protected by a password.
access_level SharingAccessLevel <optional>
 The access level on the link for this file.
audience_restricting_shared_folder SharingAudienceRestrictingSharedFolder <optional>
 The shared folder that prevents the link audience for this link from being more restrictive.
expiry Timestamp <optional>
 Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.

SharingSharedFileMembers

Shared file user, group, and invitee membership. Used for the results of list_file_members and list_file_members/continue, and used as part of the results for list_file_members/batch.
Type:
  • Object
Properties:
Name Type Argument Description
users Array.<SharingUserFileMembershipInfo> The list of user members of the shared file.
groups Array.<SharingGroupMembershipInfo> The list of group members of the shared file.
invitees Array.<SharingInviteeMembershipInfo> The list of invited members of a file, but have not logged in and claimed this.
cursor string <optional>
 Present if there are additional shared file members that have not been returned yet. Pass the cursor into list_file_members/continue to list additional members.

SharingSharedFileMetadata

Properties of the shared file.
Type:
  • Object
Properties:
Name Type Argument Description
id string The ID of the file.
name string The name of this file.
policy SharingFolderPolicy Policies governing this shared file.
preview_url string URL for displaying a web preview of the shared file.
access_type SharingAccessLevel <optional>
 The current user's access level for this shared file.
expected_link_metadata SharingExpectedSharedContentLinkMetadata <optional>
 - The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.
link_metadata SharingSharedContentLinkMetadata <optional>
 The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.
owner_display_names Array.<string> <optional>
 The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.
owner_team UsersTeam <optional>
 The team that owns the file. This field is not present if the file is not owned by a team.
parent_shared_folder_id string <optional>
 The ID of the parent shared folder. This field is present only if the file is contained within a shared folder.
path_display string <optional>
 The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.
path_lower string <optional>
 The lower-case full path of this file. Absent for unmounted files.
permissions Array.<SharingFilePermission> <optional>
 The sharing permissions that requesting user has on this file. This corresponds to the entries given in GetFileMetadataBatchArg.actions or GetFileMetadataArg.actions.
time_invited Timestamp <optional>
 Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

SharingSharedFolderAccessError

There is an error accessing the shared folder.
Type:
  • Object
Properties:
Name Type Description
.tag 'invalid_id' | 'not_a_member' | 'email_unverified' | 'unmounted' | 'other' Tag identifying the union variant.

SharingSharedFolderMemberError

Type:
  • Object
Properties:
Name Type Argument Description
no_explicit_access SharingMemberAccessLevelResult <optional>
 Available if .tag is no_explicit_access. The target member only has inherited access to the shared folder.
.tag 'invalid_dropbox_id' | 'not_a_member' | 'no_explicit_access' | 'other' Tag identifying the union variant.

SharingSharedFolderMembers

Shared folder user and group membership.
Type:
  • Object
Properties:
Name Type Argument Description
users Array.<SharingUserMembershipInfo> The list of user members of the shared folder.
groups Array.<SharingGroupMembershipInfo> The list of group members of the shared folder.
invitees Array.<SharingInviteeMembershipInfo> The list of invitees to the shared folder.
cursor string <optional>
 Present if there are additional shared folder members that have not been returned yet. Pass the cursor into list_folder_members/continue to list additional members.

SharingSharedFolderMetadata

The metadata which includes basic information about the shared folder.
Type:
  • Object
Properties:
Name Type Argument Description
access_type SharingAccessLevel The current user's access level for this shared folder.