Skip to content

Dropbox: Sharing schemas (part 1)

80 Dropbox schemas with complete fields and constraints.

← Sharing operations · All schemas

Allows a shared folder owner to unshare the folder — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
shared_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
leave_a_copybooleanOptional

Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
shared_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
memberModelRequired within parentExpand Removes a specified member from the file — request body — body member
leave_a_copybooleanRequired within parent

Referenced models: Removes a specified member from the file — request body — body member

Change the inheritance policy of an existing Shared Folder — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
access_inheritanceModelOptionalExpand Share a folder with collaborators — request body — body access inheritance
shared_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$

Referenced models: Share a folder with collaborators — request body — body access inheritance

Create a shared link with custom settings — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
pathstringRequired within parentPattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$
settingsJSONOptional
settings (anyOf 1)ModelAlternativeExpand Modify the shared link's settings — request body — body settings
settings (anyOf 2)nullAlternative

Referenced models: Modify the shared link's settings — request body — body settings

Get members of multiple files at once — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments for list_file_members/batch.
filesarrayRequired within parentMaximum items: 100
files[]stringEach itemMinimum length: 1
Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
limitintegerOptionalMinimum: 0
Maximum: 3000

Get members of multiple files at once — response body — item

FieldTypePresenceDescription and constraints
$objectRootPer-file result for list_file_members/batch.
filestringRequired within parentMinimum length: 1
Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
resultModelRequired within parentExpand Get members of multiple files at once — response body — item result

Referenced models: Get members of multiple files at once — response body — item result

Get members of multiple files at once — response body — item result

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: result
$ (anyOf 1).membersModelRequired within parentExpand Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body
$ (anyOf 1).member_countJSONRequired within parent
$ (anyOf 1).member_count (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 1).member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: access_error
$ (anyOf 2).access_errorModelRequired within parentExpand Get members of multiple files at once — response body — item result tag access error access error
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:result|access_error)$)

Referenced models: Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body, Get members of multiple files at once — response body — item result tag access error access error

Get members of multiple files at once — response body — item result tag access error access error

FieldTypePresenceDescription and constraints
$JSONRootUser could not access this file.
$ (anyOf 1)stringAlternativeKnown values: no_permission, invalid_file, is_folder, inside_public_folder, inside_osx_package
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: no_permission
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: invalid_file
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: is_folder
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: inside_public_folder
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: inside_osx_package
$ (anyOf 7)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tagstringRequired within parentPattern: ^(?!(?:no_permission|invalid_file|is_folder|inside_public_folder|inside_osx_package)$)

Get more results with a cursor from list received files — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments for list_received_files/continue.
cursorstringRequired within parent

Get the shared link's metadata — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
urlstringRequired within parent
pathJSONOptional
path (anyOf 1)stringAlternativePattern: ^(?:/(.|[\r\n])*)$
path (anyOf 2)nullAlternative
link_passwordJSONOptional
link_password (anyOf 1)stringAlternative
link_password (anyOf 2)nullAlternative

Get the shared link's metadata — response body

FieldTypePresenceDescription and constraints
$JSONRootThe metadata of a shared link.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: file
$ (anyOf 1).urlstringRequired within parent
$ (anyOf 1).idJSONOptional
$ (anyOf 1).id (anyOf 1)stringAlternativeMinimum length: 1
$ (anyOf 1).id (anyOf 2)nullAlternative
$ (anyOf 1).namestringRequired within parent
$ (anyOf 1).expiresJSONOptional
$ (anyOf 1).expires (anyOf 1)stringAlternative
$ (anyOf 1).expires (anyOf 2)nullAlternative
$ (anyOf 1).path_lowerJSONOptional
$ (anyOf 1).path_lower (anyOf 1)stringAlternative
$ (anyOf 1).path_lower (anyOf 2)nullAlternative
$ (anyOf 1).link_permissionsModelRequired within parentExpand Get the shared link's metadata — response body — tag file link permissions
$ (anyOf 1).team_member_infoJSONOptional
$ (anyOf 1).team_member_info (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file team member info Information about a team member
$ (anyOf 1).team_member_info (anyOf 2)nullAlternative
$ (anyOf 1).content_owner_team_infoJSONOptional
$ (anyOf 1).content_owner_team_info (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — owner team Information about a team
$ (anyOf 1).content_owner_team_info (anyOf 2)nullAlternative
$ (anyOf 1).preview_typeJSONOptional
$ (anyOf 1).preview_type (anyOf 1)stringAlternative
$ (anyOf 1).preview_type (anyOf 2)nullAlternative
$ (anyOf 1).created_timestampJSONOptional
$ (anyOf 1).created_timestamp (anyOf 1)stringAlternative
$ (anyOf 1).created_timestamp (anyOf 2)nullAlternative
$ (anyOf 1).client_modifiedstringRequired within parent
$ (anyOf 1).server_modifiedstringRequired within parent
$ (anyOf 1).revstringRequired within parentMinimum length: 9
Pattern: ^(?:[0-9a-f]+)$
$ (anyOf 1).sizeJSONRequired within parent
$ (anyOf 1).size (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 1).size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: folder
$ (anyOf 2).urlstringRequired within parent
$ (anyOf 2).idJSONOptional
$ (anyOf 2).id (anyOf 1)stringAlternativeMinimum length: 1
$ (anyOf 2).id (anyOf 2)nullAlternative
$ (anyOf 2).namestringRequired within parent
$ (anyOf 2).expiresJSONOptional
$ (anyOf 2).expires (anyOf 1)stringAlternative
$ (anyOf 2).expires (anyOf 2)nullAlternative
$ (anyOf 2).path_lowerJSONOptional
$ (anyOf 2).path_lower (anyOf 1)stringAlternative
$ (anyOf 2).path_lower (anyOf 2)nullAlternative
$ (anyOf 2).link_permissionsModelRequired within parentExpand Get the shared link's metadata — response body — tag file link permissions
$ (anyOf 2).team_member_infoJSONOptional
$ (anyOf 2).team_member_info (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file team member info Information about a team member
$ (anyOf 2).team_member_info (anyOf 2)nullAlternative
$ (anyOf 2).content_owner_team_infoJSONOptional
$ (anyOf 2).content_owner_team_info (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — owner team Information about a team
$ (anyOf 2).content_owner_team_info (anyOf 2)nullAlternative
$ (anyOf 2).preview_typeJSONOptional
$ (anyOf 2).preview_type (anyOf 1)stringAlternative
$ (anyOf 2).preview_type (anyOf 2)nullAlternative
$ (anyOf 2).created_timestampJSONOptional
$ (anyOf 2).created_timestamp (anyOf 1)stringAlternative
$ (anyOf 2).created_timestamp (anyOf 2)nullAlternative
$ (anyOf 3)objectAlternativeThe metadata of a shared link.
$ (anyOf 3).urlstringRequired within parent
$ (anyOf 3).idJSONOptional
$ (anyOf 3).id (anyOf 1)stringAlternativeMinimum length: 1
$ (anyOf 3).id (anyOf 2)nullAlternative
$ (anyOf 3).namestringRequired within parent
$ (anyOf 3).expiresJSONOptional
$ (anyOf 3).expires (anyOf 1)stringAlternative
$ (anyOf 3).expires (anyOf 2)nullAlternative
$ (anyOf 3).path_lowerJSONOptional
$ (anyOf 3).path_lower (anyOf 1)stringAlternative
$ (anyOf 3).path_lower (anyOf 2)nullAlternative
$ (anyOf 3).link_permissionsModelRequired within parentExpand Get the shared link's metadata — response body — tag file link permissions
$ (anyOf 3).team_member_infoJSONOptional
$ (anyOf 3).team_member_info (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file team member info Information about a team member
$ (anyOf 3).team_member_info (anyOf 2)nullAlternative
$ (anyOf 3).content_owner_team_infoJSONOptional
$ (anyOf 3).content_owner_team_info (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — owner team Information about a team
$ (anyOf 3).content_owner_team_info (anyOf 2)nullAlternative
$ (anyOf 3).preview_typeJSONOptional
$ (anyOf 3).preview_type (anyOf 1)stringAlternative
$ (anyOf 3).preview_type (anyOf 2)nullAlternative
$ (anyOf 3).created_timestampJSONOptional
$ (anyOf 3).created_timestamp (anyOf 1)stringAlternative
$ (anyOf 3).created_timestamp (anyOf 2)nullAlternative
$ (anyOf 3)..tagstringOptionalPattern: ^(?!(?:file|folder)$)

Referenced models: Get the shared link's metadata — response body — tag file link permissions, Get the shared link's metadata — response body — tag file team member info Information about a team member, Update the viewer info policy of a file — response body — owner team Information about a team

Get the shared link's metadata — response body — tag file link permissions

FieldTypePresenceDescription and constraints
$objectRoot
resolved_visibilityJSONOptional
resolved_visibility (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file link permissions resolved visibility value
resolved_visibility (anyOf 2)nullAlternative
requested_visibilityJSONOptional
requested_visibility (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file link permissions requested visibility value
requested_visibility (anyOf 2)nullAlternative
can_revokebooleanRequired within parent
revoke_failure_reasonJSONOptional
revoke_failure_reason (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file link permissions revoke failure reason value
revoke_failure_reason (anyOf 2)nullAlternative
effective_audienceJSONOptional
effective_audience (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience
effective_audience (anyOf 2)nullAlternative
link_access_levelJSONOptional
link_access_level (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file link permissions link access level value
link_access_level (anyOf 2)nullAlternative
visibility_policiesarrayRequired within parent
visibility_policies[]ModelEach itemExpand Get the shared link's metadata — response body — tag file link permissions visibility policies item
can_set_expirybooleanRequired within parent
can_remove_expirybooleanRequired within parent
allow_downloadbooleanRequired within parent
can_allow_downloadbooleanRequired within parent
can_disallow_downloadbooleanRequired within parent
allow_commentsbooleanRequired within parent
team_restricts_commentsbooleanRequired within parent
audience_optionsJSONOptional
audience_options (anyOf 1)arrayAlternative
audience_options (anyOf 1)[]ModelEach itemExpand Get the shared link's metadata — response body — tag file link permissions audience options array item
audience_options (anyOf 2)nullAlternative
can_set_passwordJSONOptional
can_set_password (anyOf 1)booleanAlternative
can_set_password (anyOf 2)nullAlternative
can_remove_passwordJSONOptional
can_remove_password (anyOf 1)booleanAlternative
can_remove_password (anyOf 2)nullAlternative
require_passwordJSONOptional
require_password (anyOf 1)booleanAlternative
require_password (anyOf 2)nullAlternative
can_use_extended_sharing_controlsJSONOptional
can_use_extended_sharing_controls (anyOf 1)booleanAlternative
can_use_extended_sharing_controls (anyOf 2)nullAlternative
can_syncJSONOptional
can_sync (anyOf 1)booleanAlternative
can_sync (anyOf 2)nullAlternative
can_request_accessJSONOptional
can_request_access (anyOf 1)booleanAlternative
can_request_access (anyOf 2)nullAlternative
enforce_shared_link_password_policyJSONOptional
enforce_shared_link_password_policy (anyOf 1)ModelAlternativeExpand Retrieves information about a team — response body — policies sharing enforce link password policy
enforce_shared_link_password_policy (anyOf 2)nullAlternative
days_to_expire_policyJSONOptional
days_to_expire_policy (anyOf 1)ModelAlternativeExpand Retrieves information about a team — response body — policies sharing default link expiration days policy
days_to_expire_policy (anyOf 2)nullAlternative
change_shared_link_expiration_policyJSONOptional
change_shared_link_expiration_policy (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file link permissions change shared link expiration policy value
change_shared_link_expiration_policy (anyOf 2)nullAlternative

Referenced models: Get the shared link's metadata — response body — tag file link permissions change shared link expiration policy value, Get the shared link's metadata — response body — tag file link permissions link access level value, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience, Get the shared link's metadata — response body — tag file link permissions audience options array item, Get the shared link's metadata — response body — tag file link permissions requested visibility value, Get the shared link's metadata — response body — tag file link permissions resolved visibility value, Get the shared link's metadata — response body — tag file link permissions revoke failure reason value, Get the shared link's metadata — response body — tag file link permissions visibility policies item, Retrieves information about a team — response body — policies sharing default link expiration days policy, Retrieves information about a team — response body — policies sharing enforce link password policy

Get the shared link's metadata — response body — tag file link permissions audience options array item

FieldTypePresenceDescription and constraints
$objectRoot
audienceModelRequired within parentExpand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience
allowedbooleanRequired within parent
disallowed_reasonJSONOptional
disallowed_reason (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file link permissions audience options array item disallowed reason value
disallowed_reason (anyOf 2)nullAlternative

Referenced models: Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience, Get the shared link's metadata — response body — tag file link permissions audience options array item disallowed reason value

Get the shared link's metadata — response body — tag file link permissions audience options array item disallowed reason value

FieldTypePresenceDescription and constraints
$JSONRootcheck documentation for VisibilityPolicyDisallowedReason.
$ (anyOf 1)stringAlternativeKnown values: delete_and_recreate, restricted_by_shared_folder, restricted_by_team, user_not_on_team, user_account_type, permission_denied
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: delete_and_recreate
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: restricted_by_shared_folder
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: restricted_by_team
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: user_not_on_team
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: user_account_type
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: permission_denied
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:delete_and_recreate|restricted_by_shared_folder|restricted_by_team|user_not_on_team|user_account_type|permission_denied)$)

Get the shared link's metadata — response body — tag file link permissions change shared link expiration policy value

FieldTypePresenceDescription and constraints
$JSONRootEnumerates acceptable values for team's ChangeLinkExpirationPolicy setting.
$ (anyOf 1)stringAlternativeKnown values: allowed, not_allowed
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: allowed
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: not_allowed
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:allowed|not_allowed)$)

Get the shared link's metadata — response body — tag file link permissions link access level value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: viewer, editor
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: viewer
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: editor
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:viewer|editor)$)

Get the shared link's metadata — response body — tag file link permissions requested visibility value

FieldTypePresenceDescription and constraints
$JSONRootThe 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.
$ (anyOf 1)stringAlternativeKnown values: public, team_only, password
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: public
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: team_only
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: password

Get the shared link's metadata — response body — tag file link permissions resolved visibility value

FieldTypePresenceDescription and constraints
$JSONRootThe 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.
$ (anyOf 1)stringAlternativeKnown values: public, team_only, password, team_and_password, shared_folder_only, no_one, only_you
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: public
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: team_only
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: password
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: team_and_password
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: shared_folder_only
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: no_one
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: only_you
$ (anyOf 9)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tagstringRequired within parentPattern: ^(?!(?:public|team_only|password|team_and_password|shared_folder_only|no_one|only_you)$)

Get the shared link's metadata — response body — tag file link permissions revoke failure reason value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: login_required, email_verify_required, password_required, team_only, owner_only
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: login_required
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: email_verify_required
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: password_required
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: team_only
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: owner_only
$ (anyOf 7)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tagstringRequired within parentPattern: ^(?!(?:login_required|email_verify_required|password_required|team_only|owner_only)$)

Get the shared link's metadata — response body — tag file link permissions visibility policies item

FieldTypePresenceDescription and constraints
$objectRoot
policyModelRequired within parentExpand Get the shared link's metadata — response body — tag file link permissions requested visibility value
resolved_policyModelRequired within parentExpand Get the shared link's metadata — response body — tag file link permissions visibility policies item resolved policy
allowedbooleanRequired within parent
disallowed_reasonJSONOptional
disallowed_reason (anyOf 1)ModelAlternativeExpand Get the shared link's metadata — response body — tag file link permissions visibility policies item disallowed reason value
disallowed_reason (anyOf 2)nullAlternative

Referenced models: Get the shared link's metadata — response body — tag file link permissions visibility policies item resolved policy, Get the shared link's metadata — response body — tag file link permissions requested visibility value, Get the shared link's metadata — response body — tag file link permissions visibility policies item disallowed reason value

Get the shared link's metadata — response body — tag file link permissions visibility policies item disallowed reason value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: delete_and_recreate, restricted_by_shared_folder, restricted_by_team, user_not_on_team, user_account_type, permission_denied
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: delete_and_recreate
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: restricted_by_shared_folder
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: restricted_by_team
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: user_not_on_team
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: user_account_type
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: permission_denied
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:delete_and_recreate|restricted_by_shared_folder|restricted_by_team|user_not_on_team|user_account_type|permission_denied)$)

Get the shared link's metadata — response body — tag file link permissions visibility policies item resolved policy

FieldTypePresenceDescription and constraints
$JSONRootcheck documentation for ResolvedVisibility.
$ (anyOf 1)stringAlternativeKnown values: public, team_only, password, team_and_password, shared_folder_only, no_one, only_you
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: public
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: team_only
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: password
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: team_and_password
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: shared_folder_only
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: no_one
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: only_you
$ (anyOf 9)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tagstringRequired within parentPattern: ^(?!(?:public|team_only|password|team_and_password|shared_folder_only|no_one|only_you)$)

Get the shared link's metadata — response body — tag file team member info Information about a team member

FieldTypePresenceDescription and constraints
$objectRootInformation about a team member.
team_infoModelRequired within parentExpand Update the viewer info policy of a file — response body — owner team Information about a team
display_namestringRequired within parent
member_idJSONOptional
member_id (anyOf 1)stringAlternative
member_id (anyOf 2)nullAlternative

Referenced models: Update the viewer info policy of a file — response body — owner team Information about a team

List shared links of this user — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
pathJSONOptional
path (anyOf 1)stringAlternativePattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$
path (anyOf 2)nullAlternative
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative
direct_onlyJSONOptional
direct_only (anyOf 1)booleanAlternative
direct_only (anyOf 2)nullAlternative

List shared links of this user — response body

FieldTypePresenceDescription and constraints
$objectRoot
linksarrayRequired within parent
links[]ModelEach itemExpand Get the shared link's metadata — response body
has_morebooleanRequired within parent
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative

Referenced models: Get the shared link's metadata — response body

Modify the shared link's settings — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
urlstringRequired within parent
settingsModelRequired within parentExpand Modify the shared link's settings — request body — body settings
remove_expirationbooleanOptional

Referenced models: Modify the shared link's settings — request body — body settings

Modify the shared link's settings — request body — body settings

FieldTypePresenceDescription and constraints
$objectRoot
require_passwordJSONOptional
require_password (anyOf 1)booleanAlternative
require_password (anyOf 2)nullAlternative
link_passwordJSONOptional
link_password (anyOf 1)stringAlternative
link_password (anyOf 2)nullAlternative
expiresJSONOptional
expires (anyOf 1)stringAlternative
expires (anyOf 2)nullAlternative
audienceJSONOptional
audience (anyOf 1)ModelAlternativeExpand Modify the shared link's settings — request body — body settings audience value
audience (anyOf 2)nullAlternative
accessJSONOptional
access (anyOf 1)ModelAlternativeExpand Modify the shared link's settings — request body — body settings access value
access (anyOf 2)nullAlternative
requested_visibilityJSONOptional
requested_visibility (anyOf 1)ModelAlternativeExpand Modify the shared link's settings — request body — body settings requested visibility value
requested_visibility (anyOf 2)nullAlternative
allow_downloadJSONOptional
allow_download (anyOf 1)booleanAlternative
allow_download (anyOf 2)nullAlternative

Referenced models: Modify the shared link's settings — request body — body settings audience value, Modify the shared link's settings — request body — body settings access value, Modify the shared link's settings — request body — body settings requested visibility value

Modify the shared link's settings — request body — body settings access value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: viewer, editor, max, default
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: viewer
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: editor
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: max
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: default
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:viewer|editor|max|default)$)

Modify the shared link's settings — request body — body settings audience value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: public, team, no_one, password, members, public_logged_in_only
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: public
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: team
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: no_one
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: password
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: members
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: public_logged_in_only
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:public|team|no_one|password|members|public_logged_in_only)$)

Modify the shared link's settings — request body — body settings requested visibility value

FieldTypePresenceDescription and constraints
$JSONRootThe 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.
$ (anyOf 1)stringAlternativeOne of: public, team_only, password
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: public
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: team_only
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: password

Once a cursor has been retrieved from list file members or list file members batch, use this to paginate through all shared file members — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments for list_file_members/continue.
cursorstringRequired within parent

Remove all members from this file — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments for unshare_file.
filestringRequired within parentMinimum length: 1
Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$

Removes a specified member from the file — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments for remove_file_member_2.
filestringRequired within parentMinimum length: 1
Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
memberModelRequired within parentExpand Removes a specified member from the file — request body — body member

Referenced models: Removes a specified member from the file — request body — body member

Removes a specified member from the file — request body — body member

FieldTypePresenceDescription and constraints
$JSONRootIncludes different ways to identify a member of a shared folder.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: dropbox_id
$ (anyOf 1).dropbox_idstringRequired within parentMinimum length: 1
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: email
$ (anyOf 2).emailstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:dropbox_id|email)$)

Removes a specified member from the file — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).access_levelJSONOptional
$ (anyOf 1).access_level (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
$ (anyOf 1).access_level (anyOf 2)nullAlternative
$ (anyOf 1).warningJSONOptional
$ (anyOf 1).warning (anyOf 1)stringAlternative
$ (anyOf 1).warning (anyOf 2)nullAlternative
$ (anyOf 1).access_detailsJSONOptional
$ (anyOf 1).access_details (anyOf 1)arrayAlternative
$ (anyOf 1).access_details (anyOf 1)[]ModelEach itemExpand Removes a specified member from the file — response body — tag success access details array item
$ (anyOf 1).access_details (anyOf 2)nullAlternative
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: member_error
$ (anyOf 2).member_errorModelRequired within parentExpand Removes a specified member from the file — response body — tag member error member error
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:success|member_error)$)

Referenced models: The current user mounts the designated folder — response body — access type, Removes a specified member from the file — response body — tag member error member error, Removes a specified member from the file — response body — tag success access details array item

Removes a specified member from the file — response body — tag member error member error

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: invalid_member, no_permission
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_member
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: no_permission
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: access_error
$ (anyOf 4).access_errorModelRequired within parentExpand Get members of multiple files at once — response body — item result tag access error access error
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: no_explicit_access
$ (anyOf 5).access_levelJSONOptional
$ (anyOf 5).access_level (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
$ (anyOf 5).access_level (anyOf 2)nullAlternative
$ (anyOf 5).warningJSONOptional
$ (anyOf 5).warning (anyOf 1)stringAlternative
$ (anyOf 5).warning (anyOf 2)nullAlternative
$ (anyOf 5).access_detailsJSONOptional
$ (anyOf 5).access_details (anyOf 1)arrayAlternative
$ (anyOf 5).access_details (anyOf 1)[]ModelEach itemExpand Removes a specified member from the file — response body — tag success access details array item
$ (anyOf 5).access_details (anyOf 2)nullAlternative
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:invalid_member|no_permission|access_error|no_explicit_access)$)

Referenced models: The current user mounts the designated folder — response body — access type, Removes a specified member from the file — response body — tag success access details array item, Get members of multiple files at once — response body — item result tag access error access error

Removes a specified member from the file — response body — tag success access details array item

FieldTypePresenceDescription and constraints
$objectRootContains information about a parent folder that a member has access to.
folder_namestringRequired within parent
shared_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
permissionsarrayRequired within parent
permissions[]ModelEach itemExpand Returns shared folder membership by its folder ID — response body — users item permissions array item
pathstringRequired within parent

Referenced models: Returns shared folder membership by its folder ID — response body — users item permissions array item

Return the list of all shared folders the current user has access to — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
limitintegerOptionalMinimum: 1
Maximum: 1000
actionsJSONOptional
actions (anyOf 1)arrayAlternative
actions (anyOf 1)[]ModelEach itemExpand Share a folder with collaborators — request body — body actions array item
actions (anyOf 2)nullAlternative

Referenced models: Share a folder with collaborators — request body — body actions array item

Return the list of all shared folders the current user has access to — response body

FieldTypePresenceDescription and constraints
$objectRootResult 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.
entriesarrayRequired within parent
entries[]ModelEach itemExpand The current user mounts the designated folder — response body
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative

Referenced models: The current user mounts the designated folder — response body

Returns a list of all files shared with current user — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments for list_received_files.
limitintegerOptionalMinimum: 1
Maximum: 300
actionsJSONOptional
actions (anyOf 1)arrayAlternative
actions (anyOf 1)[]ModelEach itemExpand Update the viewer info policy of a file — request body — body actions array item
actions (anyOf 2)nullAlternative

Referenced models: Update the viewer info policy of a file — request body — body actions array item

Returns a list of all files shared with current user — response body

FieldTypePresenceDescription and constraints
$objectRootSuccess results for list_received_files.
entriesarrayRequired within parent
entries[]ModelEach itemExpand Update the viewer info policy of a file — response body
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative

Referenced models: Update the viewer info policy of a file — response body

Returns shared file metadata — sharing get File Metadata Batch — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments of get_file_metadata/batch.
filesarrayRequired within parentMaximum items: 100
files[]stringEach itemMinimum length: 1
Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
actionsJSONOptional
actions (anyOf 1)arrayAlternative
actions (anyOf 1)[]ModelEach itemExpand Update the viewer info policy of a file — request body — body actions array item
actions (anyOf 2)nullAlternative

Referenced models: Update the viewer info policy of a file — request body — body actions array item

Returns shared file metadata — sharing get File Metadata Batch — response body — item

FieldTypePresenceDescription and constraints
$objectRootPer file results of get_file_metadata/batch.
filestringRequired within parentMinimum length: 1
Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
resultModelRequired within parentExpand Returns shared file metadata — sharing get File Metadata Batch — response body — item result

Referenced models: Returns shared file metadata — sharing get File Metadata Batch — response body — item result

Returns shared file metadata — sharing get File Metadata Batch — response body — item result

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: metadata
$ (anyOf 1).access_typeJSONOptional
$ (anyOf 1).access_type (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
$ (anyOf 1).access_type (anyOf 2)nullAlternative
$ (anyOf 1).idstringRequired within parentMinimum length: 4
Pattern: ^(?:id:.+)$
$ (anyOf 1).expected_link_metadataJSONOptional
$ (anyOf 1).expected_link_metadata (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — expected link metadata access level, audience options, audience restricting shared folder, current audience, expiry, link permissions, password protected
$ (anyOf 1).expected_link_metadata (anyOf 2)nullAlternative
$ (anyOf 1).link_metadataJSONOptional
$ (anyOf 1).link_metadata (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder
$ (anyOf 1).link_metadata (anyOf 2)nullAlternative
$ (anyOf 1).namestringRequired within parent
$ (anyOf 1).owner_display_namesJSONOptional
$ (anyOf 1).owner_display_names (anyOf 1)arrayAlternative
$ (anyOf 1).owner_display_names (anyOf 1)[]stringEach item
$ (anyOf 1).owner_display_names (anyOf 2)nullAlternative
$ (anyOf 1).owner_teamJSONOptional
$ (anyOf 1).owner_team (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — owner team Information about a team
$ (anyOf 1).owner_team (anyOf 2)nullAlternative
$ (anyOf 1).parent_shared_folder_idJSONOptional
$ (anyOf 1).parent_shared_folder_id (anyOf 1)stringAlternativePattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 1).parent_shared_folder_id (anyOf 2)nullAlternative
$ (anyOf 1).path_displayJSONOptional
$ (anyOf 1).path_display (anyOf 1)stringAlternative
$ (anyOf 1).path_display (anyOf 2)nullAlternative
$ (anyOf 1).path_lowerJSONOptional
$ (anyOf 1).path_lower (anyOf 1)stringAlternative
$ (anyOf 1).path_lower (anyOf 2)nullAlternative
$ (anyOf 1).permissionsJSONOptional
$ (anyOf 1).permissions (anyOf 1)arrayAlternative
$ (anyOf 1).permissions (anyOf 1)[]ModelEach itemExpand Update the viewer info policy of a file — response body — permissions array item
$ (anyOf 1).permissions (anyOf 2)nullAlternative
$ (anyOf 1).policyModelRequired within parentExpand Update the viewer info policy of a file — response body — policy
$ (anyOf 1).preview_urlstringRequired within parent
$ (anyOf 1).time_invitedJSONOptional
$ (anyOf 1).time_invited (anyOf 1)stringAlternative
$ (anyOf 1).time_invited (anyOf 2)nullAlternative
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: access_error
$ (anyOf 2).access_errorModelRequired within parentExpand Get members of multiple files at once — response body — item result tag access error access error
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:metadata|access_error)$)

Referenced models: The current user mounts the designated folder — response body — access type, Update the viewer info policy of a file — response body — expected link metadata access level, audience options, audience restricting shared folder, current audience, expiry, link permissions, password protected, Update the viewer info policy of a file — response body — permissions array item, Update the viewer info policy of a file — response body — policy, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder, Get members of multiple files at once — response body — item result tag access error access error, Update the viewer info policy of a file — response body — owner team Information about a team

Returns shared file metadata — sharing get File Metadata — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments of get_file_metadata.
filestringRequired within parentMinimum length: 1
Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$
actionsJSONOptional
actions (anyOf 1)arrayAlternative
actions (anyOf 1)[]ModelEach itemExpand Update the viewer info policy of a file — request body — body actions array item
actions (anyOf 2)nullAlternative

Referenced models: Update the viewer info policy of a file — request body — body actions array item

Returns shared folder membership by its folder ID — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
actionsJSONOptional
actions (anyOf 1)arrayAlternative
actions (anyOf 1)[]ModelEach itemExpand Returns shared folder membership by its folder ID — request body — body actions array item
actions (anyOf 2)nullAlternative
limitintegerOptionalMinimum: 1
Maximum: 1000
shared_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
pathJSONOptional
path (anyOf 1)stringAlternative
path (anyOf 2)nullAlternative

Referenced models: Returns shared folder membership by its folder ID — request body — body actions array item

Returns shared folder membership by its folder ID — request body — body actions array item

FieldTypePresenceDescription and constraints
$JSONRootActions that may be taken on members of a shared folder.
$ (anyOf 1)stringAlternativeOne of: leave_a_copy, make_editor, make_owner, make_viewer, make_viewer_no_comment, remove
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: leave_a_copy
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: make_editor
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: make_owner
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: make_viewer
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: make_viewer_no_comment
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: remove
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:leave_a_copy|make_editor|make_owner|make_viewer|make_viewer_no_comment|remove)$)

Returns shared folder membership by its folder ID — response body

FieldTypePresenceDescription and constraints
$objectRootShared folder user and group membership.
usersarrayRequired within parent
users[]ModelEach itemExpand Returns shared folder membership by its folder ID — response body — users item
groupsarrayRequired within parent
groups[]ModelEach itemExpand Returns shared folder membership by its folder ID — response body — groups item
inviteesarrayRequired within parent
invitees[]ModelEach itemExpand Returns shared folder membership by its folder ID — response body — invitees item
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative

Referenced models: Returns shared folder membership by its folder ID — response body — groups item, Returns shared folder membership by its folder ID — response body — invitees item, Returns shared folder membership by its folder ID — response body — users item

Returns shared folder membership by its folder ID — response body — groups item

FieldTypePresenceDescription and constraints
$objectRootThe information about a group member of the shared content.
access_typeModelRequired within parentExpand The current user mounts the designated folder — response body — access type
permissionsJSONOptional
permissions (anyOf 1)arrayAlternative
permissions (anyOf 1)[]ModelEach itemExpand Returns shared folder membership by its folder ID — response body — users item permissions array item
permissions (anyOf 2)nullAlternative
initialsJSONOptional
initials (anyOf 1)stringAlternative
initials (anyOf 2)nullAlternative
is_inheritedbooleanOptional
inherited_access_typeJSONOptional
inherited_access_type (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
inherited_access_type (anyOf 2)nullAlternative
groupModelRequired within parentExpand Returns shared folder membership by its folder ID — response body — groups item group

Referenced models: The current user mounts the designated folder — response body — access type, Returns shared folder membership by its folder ID — response body — groups item group, Returns shared folder membership by its folder ID — response body — users item permissions array item

Returns shared folder membership by its folder ID — response body — groups item group

FieldTypePresenceDescription and constraints
$objectRootThe information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.
group_namestringRequired within parent
group_idstringRequired within parent
group_external_idJSONOptional
group_external_id (anyOf 1)stringAlternative
group_external_id (anyOf 2)nullAlternative
member_countJSONOptional
member_count (anyOf 1)JSONAlternative
member_count (anyOf 1) (anyOf 1)integerAlternativeMinimum: 0
member_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
member_count (anyOf 2)nullAlternative
group_management_typeModelRequired within parentExpand Updates a group's name and or external ID — response body — group management type
group_typeModelRequired within parentExpand Returns shared folder membership by its folder ID — response body — groups item group group type
is_memberbooleanRequired within parent
is_ownerbooleanRequired within parent
same_teambooleanRequired within parent

Referenced models: Updates a group's name and or external ID — response body — group management type, Returns shared folder membership by its folder ID — response body — groups item group group type

Returns shared folder membership by its folder ID — response body — groups item group group type

FieldTypePresenceDescription and constraints
$JSONRootThe group type determines how a group is created and managed.
$ (anyOf 1)stringAlternativeKnown values: team, user_managed
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: team
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: user_managed
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:team|user_managed)$)

Returns shared folder membership by its folder ID — response body — invitees item

FieldTypePresenceDescription and constraints
$objectRootInformation about an invited member of a shared content.
access_typeModelRequired within parentExpand The current user mounts the designated folder — response body — access type
permissionsJSONOptional
permissions (anyOf 1)arrayAlternative
permissions (anyOf 1)[]ModelEach itemExpand Returns shared folder membership by its folder ID — response body — users item permissions array item
permissions (anyOf 2)nullAlternative
initialsJSONOptional
initials (anyOf 1)stringAlternative
initials (anyOf 2)nullAlternative
is_inheritedbooleanOptional
inherited_access_typeJSONOptional
inherited_access_type (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
inherited_access_type (anyOf 2)nullAlternative
inviteeModelRequired within parentExpand Returns shared folder membership by its folder ID — response body — invitees item invitee
userJSONOptional
user (anyOf 1)ModelAlternativeExpand Returns shared folder membership by its folder ID — response body — users item user
user (anyOf 2)nullAlternative

Referenced models: The current user mounts the designated folder — response body — access type, Returns shared folder membership by its folder ID — response body — invitees item invitee, Returns shared folder membership by its folder ID — response body — users item permissions array item, Returns shared folder membership by its folder ID — response body — users item user

Returns shared folder membership by its folder ID — response body — invitees item invitee

FieldTypePresenceDescription and constraints
$JSONRootInformation about the recipient of a shared content invitation.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: email
$ (anyOf 1).emailstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 2)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tagstringRequired within parentPattern: ^(?!(?:email)$)

Returns shared folder membership by its folder ID — response body — users item

FieldTypePresenceDescription and constraints
$objectRootThe information about a user member of the shared content.
access_typeModelRequired within parentExpand The current user mounts the designated folder — response body — access type
permissionsJSONOptional
permissions (anyOf 1)arrayAlternative
permissions (anyOf 1)[]ModelEach itemExpand Returns shared folder membership by its folder ID — response body — users item permissions array item
permissions (anyOf 2)nullAlternative
initialsJSONOptional
initials (anyOf 1)stringAlternative
initials (anyOf 2)nullAlternative
is_inheritedbooleanOptional
inherited_access_typeJSONOptional
inherited_access_type (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
inherited_access_type (anyOf 2)nullAlternative
userModelRequired within parentExpand Returns shared folder membership by its folder ID — response body — users item user

Referenced models: The current user mounts the designated folder — response body — access type, Returns shared folder membership by its folder ID — response body — users item permissions array item, Returns shared folder membership by its folder ID — response body — users item user

Returns shared folder membership by its folder ID — response body — users item permissions array item

FieldTypePresenceDescription and constraints
$objectRootWhether the user is allowed to take the action on the associated member.
actionModelRequired within parentExpand Returns shared folder membership by its folder ID — response body — users item permissions array item action
allowbooleanRequired within parent
reasonJSONOptional
reason (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission
reason (anyOf 2)nullAlternative

Referenced models: Returns shared folder membership by its folder ID — response body — users item permissions array item action, Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission

Returns shared folder membership by its folder ID — response body — users item permissions array item action

FieldTypePresenceDescription and constraints
$JSONRootActions that may be taken on members of a shared folder.
$ (anyOf 1)stringAlternativeKnown values: leave_a_copy, make_editor, make_owner, make_viewer, make_viewer_no_comment, remove
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: leave_a_copy
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: make_editor
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: make_owner
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: make_viewer
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: make_viewer_no_comment
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: remove
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:leave_a_copy|make_editor|make_owner|make_viewer|make_viewer_no_comment|remove)$)

Returns shared folder membership by its folder ID — response body — users item user

FieldTypePresenceDescription and constraints
$objectRootBasic information about a user. Use users.get_account and users.get_account_batch to obtain more detailed information.
account_idstringRequired within parentMaximum length: 40
Minimum length: 40
emailstringRequired within parent
display_namestringRequired within parent
same_teambooleanRequired within parent
team_member_idJSONOptional
team_member_id (anyOf 1)stringAlternative
team_member_id (anyOf 2)nullAlternative

Returns shared folder metadata by its folder ID — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
shared_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
actionsJSONOptional
actions (anyOf 1)arrayAlternative
actions (anyOf 1)[]ModelEach itemExpand Share a folder with collaborators — request body — body actions array item
actions (anyOf 2)nullAlternative

Referenced models: Share a folder with collaborators — request body — body actions array item

Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: in_progress
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: complete
$ (anyOf 3).access_levelJSONOptional
$ (anyOf 3).access_level (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
$ (anyOf 3).access_level (anyOf 2)nullAlternative
$ (anyOf 3).warningJSONOptional
$ (anyOf 3).warning (anyOf 1)stringAlternative
$ (anyOf 3).warning (anyOf 2)nullAlternative
$ (anyOf 3).access_detailsJSONOptional
$ (anyOf 3).access_details (anyOf 1)arrayAlternative
$ (anyOf 3).access_details (anyOf 1)[]ModelEach itemExpand Removes a specified member from the file — response body — tag success access details array item
$ (anyOf 3).access_details (anyOf 2)nullAlternative
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: failed
$ (anyOf 4).failedModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed

Referenced models: The current user mounts the designated folder — response body — access type, Removes a specified member from the file — response body — tag success access details array item, Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed

Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: folder_owner, group_access, team_folder, no_permission, too_many_files
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: access_error
$ (anyOf 2).access_errorModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: member_error
$ (anyOf 3).member_errorModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag member error member error
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: folder_owner
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: group_access
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: team_folder
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: no_permission
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: too_many_files
$ (anyOf 9)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tagstringRequired within parentPattern: ^(?!(?:access_error|member_error|folder_owner|group_access|team_folder|no_permission|too_many_files)$)

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error, Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag member error member error

Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error

FieldTypePresenceDescription and constraints
$JSONRootThere is an error accessing the shared folder.
$ (anyOf 1)stringAlternativeKnown values: invalid_id, not_a_member, invalid_member, email_unverified, unmounted
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_id
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: not_a_member
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: invalid_member
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: email_unverified
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: unmounted
$ (anyOf 7)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tagstringRequired within parentPattern: ^(?!(?:invalid_id|not_a_member|invalid_member|email_unverified|unmounted)$)

Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag member error member error

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: invalid_dropbox_id, not_a_member
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_dropbox_id
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: not_a_member
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: no_explicit_access
$ (anyOf 4).access_levelJSONOptional
$ (anyOf 4).access_level (anyOf 1)ModelAlternativeExpand The current user mounts the designated folder — response body — access type
$ (anyOf 4).access_level (anyOf 2)nullAlternative
$ (anyOf 4).warningJSONOptional
$ (anyOf 4).warning (anyOf 1)stringAlternative
$ (anyOf 4).warning (anyOf 2)nullAlternative
$ (anyOf 4).access_detailsJSONOptional
$ (anyOf 4).access_details (anyOf 1)arrayAlternative
$ (anyOf 4).access_details (anyOf 1)[]ModelEach itemExpand Removes a specified member from the file — response body — tag success access details array item
$ (anyOf 4).access_details (anyOf 2)nullAlternative
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:invalid_dropbox_id|not_a_member|no_explicit_access)$)

Referenced models: The current user mounts the designated folder — response body — access type, Removes a specified member from the file — response body — tag success access details array item

Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: in_progress
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)ModelAlternativeExpand Share a folder with collaborators — response body — tag complete
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: failed
$ (anyOf 4).failedModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed, Share a folder with collaborators — response body — tag complete

Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: email_unverified, team_policy_disallows_member_policy, disallowed_shared_link_policy, no_permission
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: email_unverified
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: bad_path
$ (anyOf 3).bad_pathModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag bad path bad path
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: team_policy_disallows_member_policy
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: disallowed_shared_link_policy
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: too_many_mounts
$ (anyOf 6).too_many_mountsModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag too many mounts too many mounts
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: no_permission
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:email_unverified|bad_path|team_policy_disallows_member_policy|disallowed_shared_link_policy|too_many_mounts|no_permission)$)

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag bad path bad path, Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag too many mounts too many mounts

Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag bad path bad path

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: is_file, inside_shared_folder, contains_shared_folder, contains_app_folder, contains_team_folder, is_app_folder, inside_app_folder, is_public_folder, inside_public_folder, invalid_path, is_osx_package, inside_osx_package, is_vault, is_vault_locked, is_family
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: is_file
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: inside_shared_folder
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: contains_shared_folder
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: contains_app_folder
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: contains_team_folder
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: is_app_folder
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: inside_app_folder
$ (anyOf 9)objectAlternative
$ (anyOf 9)..tagstringRequired within parentMust equal: is_public_folder
$ (anyOf 10)objectAlternative
$ (anyOf 10)..tagstringRequired within parentMust equal: inside_public_folder
$ (anyOf 11)objectAlternative
$ (anyOf 11)..tagstringRequired within parentMust equal: already_shared
$ (anyOf 11).access_typeModelRequired within parentExpand The current user mounts the designated folder — response body — access type
$ (anyOf 11).is_inside_team_folderbooleanRequired within parent
$ (anyOf 11).is_team_folderbooleanRequired within parent
$ (anyOf 11).owner_display_namesJSONOptional
$ (anyOf 11).owner_display_names (anyOf 1)arrayAlternative
$ (anyOf 11).owner_display_names (anyOf 1)[]stringEach item
$ (anyOf 11).owner_display_names (anyOf 2)nullAlternative
$ (anyOf 11).owner_teamJSONOptional
$ (anyOf 11).owner_team (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — owner team Information about a team
$ (anyOf 11).owner_team (anyOf 2)nullAlternative
$ (anyOf 11).parent_shared_folder_idJSONOptional
$ (anyOf 11).parent_shared_folder_id (anyOf 1)stringAlternativePattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 11).parent_shared_folder_id (anyOf 2)nullAlternative
$ (anyOf 11).path_displayJSONOptional
$ (anyOf 11).path_display (anyOf 1)stringAlternative
$ (anyOf 11).path_display (anyOf 2)nullAlternative
$ (anyOf 11).path_lowerJSONOptional
$ (anyOf 11).path_lower (anyOf 1)stringAlternative
$ (anyOf 11).path_lower (anyOf 2)nullAlternative
$ (anyOf 11).parent_folder_nameJSONOptional
$ (anyOf 11).parent_folder_name (anyOf 1)stringAlternative
$ (anyOf 11).parent_folder_name (anyOf 2)nullAlternative
$ (anyOf 11).link_metadataJSONOptional
$ (anyOf 11).link_metadata (anyOf 1)ModelAlternativeExpand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder
$ (anyOf 11).link_metadata (anyOf 2)nullAlternative
$ (anyOf 11).namestringRequired within parent
$ (anyOf 11).permissionsJSONOptional
$ (anyOf 11).permissions (anyOf 1)arrayAlternative
$ (anyOf 11).permissions (anyOf 1)[]ModelEach itemExpand The current user mounts the designated folder — response body — permissions array item
$ (anyOf 11).permissions (anyOf 2)nullAlternative
$ (anyOf 11).policyModelRequired within parentExpand Update the viewer info policy of a file — response body — policy
$ (anyOf 11).preview_urlstringRequired within parent
$ (anyOf 11).shared_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 11).time_invitedstringRequired within parent
$ (anyOf 11).access_inheritanceModelOptionalExpand The current user mounts the designated folder — response body — access inheritance
$ (anyOf 11).folder_idJSONOptional
$ (anyOf 11).folder_id (anyOf 1)stringAlternativeMinimum length: 4
Pattern: ^(?:id:.+)$
$ (anyOf 11).folder_id (anyOf 2)nullAlternative
$ (anyOf 12)objectAlternative
$ (anyOf 12)..tagstringRequired within parentMust equal: invalid_path
$ (anyOf 13)objectAlternative
$ (anyOf 13)..tagstringRequired within parentMust equal: is_osx_package
$ (anyOf 14)objectAlternative
$ (anyOf 14)..tagstringRequired within parentMust equal: inside_osx_package
$ (anyOf 15)objectAlternative
$ (anyOf 15)..tagstringRequired within parentMust equal: is_vault
$ (anyOf 16)objectAlternative
$ (anyOf 16)..tagstringRequired within parentMust equal: is_vault_locked
$ (anyOf 17)objectAlternative
$ (anyOf 17)..tagstringRequired within parentMust equal: is_family
$ (anyOf 18)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 18)..tagstringRequired within parentPattern: ^(?!(?:is_file|inside_shared_folder|contains_shared_folder|contains_app_folder|contains_team_folder|is_app_folder|inside_app_folder|is_public_folder|inside_public_folder|already_shared|invalid_path|is_osx_package|inside_osx_package|is_vault|is_vault_locked|is_family)$)

Referenced models: The current user mounts the designated folder — response body — access inheritance, The current user mounts the designated folder — response body — access type, The current user mounts the designated folder — response body — permissions array item, Update the viewer info policy of a file — response body — policy, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder, Update the viewer info policy of a file — response body — owner team Information about a team

Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag too many mounts too many mounts

FieldTypePresenceDescription and constraints
$JSONRootThis operation would exceed the maximum number of mounts allowed.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: total_mounts_exceeded
$ (anyOf 1).limitJSONRequired within parent
$ (anyOf 1).limit (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 1).limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).current_countJSONRequired within parent
$ (anyOf 1).current_count (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 1).current_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).new_countJSONRequired within parent
$ (anyOf 1).new_count (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 1).new_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: home_mounts_exceeded
$ (anyOf 2).limitJSONRequired within parent
$ (anyOf 2).limit (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 2).limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2).current_countJSONRequired within parent
$ (anyOf 2).current_count (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 2).current_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2).new_countJSONRequired within parent
$ (anyOf 2).new_count (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 2).new_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: tree_size_exceeded
$ (anyOf 3).limitJSONRequired within parent
$ (anyOf 3).limit (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 3).limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3).current_countJSONRequired within parent
$ (anyOf 3).current_count (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 3).current_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3).new_countJSONRequired within parent
$ (anyOf 3).new_count (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 3).new_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:total_mounts_exceeded|home_mounts_exceeded|tree_size_exceeded)$)

Returns the status of an asynchronous job — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: in_progress, complete
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: complete
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: failed
$ (anyOf 4).failedModelRequired within parentExpand Returns the status of an asynchronous job — response body — tag failed failed

Referenced models: Returns the status of an asynchronous job — response body — tag failed failed

Returns the status of an asynchronous job — response body — tag failed failed

FieldTypePresenceDescription and constraints
$JSONRootError occurred while performing an asynchronous job from unshare_folder or remove_folder_member.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: unshare_folder_error
$ (anyOf 1).unshare_folder_errorModelRequired within parentExpand Returns the status of an asynchronous job — response body — tag failed failed tag unshare folder error unshare folder error
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: remove_folder_member_error
$ (anyOf 2).remove_folder_member_errorModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: relinquish_folder_membership_error
$ (anyOf 3).relinquish_folder_membership_errorModelRequired within parentExpand Returns the status of an asynchronous job — response body — tag failed failed tag relinquish folder membership error relinquish folder membership error
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:unshare_folder_error|remove_folder_member_error|relinquish_folder_membership_error)$)

Referenced models: Returns the status of an asynchronous job — response body — tag failed failed tag relinquish folder membership error relinquish folder membership error, Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed, Returns the status of an asynchronous job — response body — tag failed failed tag unshare folder error unshare folder error

Returns the status of an asynchronous job — response body — tag failed failed tag relinquish folder membership error relinquish folder membership error

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: folder_owner, mounted, group_access, team_folder, no_permission, no_explicit_access
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: access_error
$ (anyOf 2).access_errorModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: folder_owner
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: mounted
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: group_access
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: team_folder
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: no_permission
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: no_explicit_access
$ (anyOf 9)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tagstringRequired within parentPattern: ^(?!(?:access_error|folder_owner|mounted|group_access|team_folder|no_permission|no_explicit_access)$)

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error

Returns the status of an asynchronous job — response body — tag failed failed tag unshare folder error unshare folder error

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: team_folder, no_permission, too_many_files
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: access_error
$ (anyOf 2).access_errorModelRequired within parentExpand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: team_folder
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: no_permission
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: too_many_files
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:access_error|team_folder|no_permission|too_many_files)$)

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error

Revoke a shared link — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
urlstringRequired within parent

Share a folder with collaborators — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
acl_update_policyJSONOptional
acl_update_policy (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body acl update policy value
acl_update_policy (anyOf 2)nullAlternative
force_asyncbooleanOptional
member_policyJSONOptional
member_policy (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body member policy value
member_policy (anyOf 2)nullAlternative
pathstringRequired within parentPattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$
shared_link_policyJSONOptional
shared_link_policy (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body shared link policy Who can view shared links in this folder
shared_link_policy (anyOf 2)nullAlternative
viewer_info_policyJSONOptional
viewer_info_policy (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body viewer info policy value
viewer_info_policy (anyOf 2)nullAlternative
access_inheritanceModelOptionalExpand Share a folder with collaborators — request body — body access inheritance
actionsJSONOptional
actions (anyOf 1)arrayAlternative
actions (anyOf 1)[]ModelEach itemExpand Share a folder with collaborators — request body — body actions array item
actions (anyOf 2)nullAlternative
link_settingsJSONOptional
link_settings (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body link settings Settings that apply to a link
link_settings (anyOf 2)nullAlternative

Referenced models: Share a folder with collaborators — request body — body access inheritance, Share a folder with collaborators — request body — body acl update policy value, Share a folder with collaborators — request body — body actions array item, Share a folder with collaborators — request body — body link settings Settings that apply to a link, Share a folder with collaborators — request body — body member policy value, Share a folder with collaborators — request body — body shared link policy Who can view shared links in this folder, Share a folder with collaborators — request body — body viewer info policy value

Share a folder with collaborators — request body — body access inheritance

FieldTypePresenceDescription and constraints
$JSONRootInformation about the inheritance policy of a shared folder.
$ (anyOf 1)stringAlternativeOne of: inherit, no_inherit
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: inherit
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: no_inherit
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:inherit|no_inherit)$)

Share a folder with collaborators — request body — body acl update policy value

FieldTypePresenceDescription and constraints
$JSONRootWho can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.
$ (anyOf 1)stringAlternativeOne of: owner, editors
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: owner
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: editors
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:owner|editors)$)

Share a folder with collaborators — request body — body actions array item

FieldTypePresenceDescription and constraints
$JSONRootActions that may be taken on shared folders.
$ (anyOf 1)stringAlternativeOne of: 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, create_view_link, create_edit_link, set_access_inheritance
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: change_options
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: disable_viewer_info
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: edit_contents
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: enable_viewer_info
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: invite_editor
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: invite_viewer
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: invite_viewer_no_comment
$ (anyOf 9)objectAlternative
$ (anyOf 9)..tagstringRequired within parentMust equal: relinquish_membership
$ (anyOf 10)objectAlternative
$ (anyOf 10)..tagstringRequired within parentMust equal: unmount
$ (anyOf 11)objectAlternative
$ (anyOf 11)..tagstringRequired within parentMust equal: unshare
$ (anyOf 12)objectAlternative
$ (anyOf 12)..tagstringRequired within parentMust equal: leave_a_copy
$ (anyOf 13)objectAlternative
$ (anyOf 13)..tagstringRequired within parentMust equal: share_link
$ (anyOf 14)objectAlternative
$ (anyOf 14)..tagstringRequired within parentMust equal: create_link
$ (anyOf 15)objectAlternative
$ (anyOf 15)..tagstringRequired within parentMust equal: create_view_link
$ (anyOf 16)objectAlternative
$ (anyOf 16)..tagstringRequired within parentMust equal: create_edit_link
$ (anyOf 17)objectAlternative
$ (anyOf 17)..tagstringRequired within parentMust equal: set_access_inheritance
$ (anyOf 18)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 18)..tagstringRequired within parentPattern: ^(?!(?: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|create_view_link|create_edit_link|set_access_inheritance)$)

Share a folder with collaborators — request body — body link settings Settings that apply to a link

FieldTypePresenceDescription and constraints
$objectRootSettings that apply to a link.
access_levelJSONOptional
access_level (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body link settings Settings that apply to a link access level Defines the access levels for collaborators
access_level (anyOf 2)nullAlternative
audienceJSONOptional
audience (anyOf 1)ModelAlternativeExpand Modify the shared link's settings — request body — body settings audience value
audience (anyOf 2)nullAlternative
expiryJSONOptional
expiry (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body link settings Settings that apply to a link expiry value
expiry (anyOf 2)nullAlternative
passwordJSONOptional
password (anyOf 1)ModelAlternativeExpand Share a folder with collaborators — request body — body link settings Settings that apply to a link password value
password (anyOf 2)nullAlternative

Referenced models: Share a folder with collaborators — request body — body link settings Settings that apply to a link access level Defines the access levels for collaborators, Modify the shared link's settings — request body — body settings audience value, Share a folder with collaborators — request body — body link settings Settings that apply to a link expiry value, Share a folder with collaborators — request body — body link settings Settings that apply to a link password value

Share a folder with collaborators — request body — body link settings Settings that apply to a link access level Defines the access levels for collaborators

FieldTypePresenceDescription and constraints
$JSONRootDefines the access levels for collaborators.
$ (anyOf 1)stringAlternativeOne of: owner, editor, viewer, viewer_no_comment, traverse, no_access
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: owner
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: editor
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: viewer
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: viewer_no_comment
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: traverse
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: no_access
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:owner|editor|viewer|viewer_no_comment|traverse|no_access)$)

Share a folder with collaborators — request body — body link settings Settings that apply to a link expiry value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: remove_expiry
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: remove_expiry
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: set_expiry
$ (anyOf 3).set_expirystringRequired within parent
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:remove_expiry|set_expiry)$)

Share a folder with collaborators — request body — body link settings Settings that apply to a link password value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: remove_password
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: remove_password
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: set_password
$ (anyOf 3).set_passwordstringRequired within parent
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:remove_password|set_password)$)

Share a folder with collaborators — request body — body member policy value

FieldTypePresenceDescription and constraints
$JSONRootPolicy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.
$ (anyOf 1)stringAlternativeOne of: team, anyone, team_and_approved
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: team
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: anyone
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: team_and_approved
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:team|anyone|team_and_approved)$)

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.