← Sharing operations · All schemas
Allows a shared folder owner to unshare the folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
shared_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
leave_a_copy | boolean | Optional | |
Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member — request body — body
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
Referenced models: Share a folder with collaborators — request body — body access inheritance
Create a shared link with custom settings — request body — body
Referenced models: Modify the shared link's settings — request body — body settings
Get members of multiple files at once — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Arguments for list_file_members/batch. |
files | array | Required within parent | Maximum items: 100 |
files[] | string | Each item | Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$ |
limit | integer | Optional | Minimum: 0 Maximum: 3000 |
Get members of multiple files at once — response body — item
Referenced models: Get members of multiple files at once — response body — item result
Get members of multiple files at once — response body — item result
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | User could not access this file. |
$ (anyOf 1) | string | Alternative | Known values: no_permission, invalid_file, is_folder, inside_public_folder, inside_osx_package |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: no_permission |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: invalid_file |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: is_folder |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: inside_public_folder |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: inside_osx_package |
$ (anyOf 7) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 7)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Arguments for list_received_files/continue. |
cursor | string | Required within parent | |
Get the shared link's metadata — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
url | string | Required within parent | |
path | JSON | Optional | |
path (anyOf 1) | string | Alternative | Pattern: ^(?:/(.|[\r\n])*)$ |
path (anyOf 2) | null | Alternative | |
link_password | JSON | Optional | |
link_password (anyOf 1) | string | Alternative | |
link_password (anyOf 2) | null | Alternative | |
Get the shared link's metadata — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The metadata of a shared link. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: file |
$ (anyOf 1).url | string | Required within parent | |
$ (anyOf 1).id | JSON | Optional | |
$ (anyOf 1).id (anyOf 1) | string | Alternative | Minimum length: 1 |
$ (anyOf 1).id (anyOf 2) | null | Alternative | |
$ (anyOf 1).name | string | Required within parent | |
$ (anyOf 1).expires | JSON | Optional | |
$ (anyOf 1).expires (anyOf 1) | string | Alternative | |
$ (anyOf 1).expires (anyOf 2) | null | Alternative | |
$ (anyOf 1).path_lower | JSON | Optional | |
$ (anyOf 1).path_lower (anyOf 1) | string | Alternative | |
$ (anyOf 1).path_lower (anyOf 2) | null | Alternative | |
$ (anyOf 1).link_permissions | Model | Required within parent | Expand Get the shared link's metadata — response body — tag file link permissions |
$ (anyOf 1).team_member_info | JSON | Optional | |
$ (anyOf 1).team_member_info (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
$ (anyOf 1).content_owner_team_info | JSON | Optional | |
$ (anyOf 1).content_owner_team_info (anyOf 1) | Model | Alternative | Expand Update the viewer info policy of a file — response body — owner team Information about a team |
$ (anyOf 1).content_owner_team_info (anyOf 2) | null | Alternative | |
$ (anyOf 1).preview_type | JSON | Optional | |
$ (anyOf 1).preview_type (anyOf 1) | string | Alternative | |
$ (anyOf 1).preview_type (anyOf 2) | null | Alternative | |
$ (anyOf 1).created_timestamp | JSON | Optional | |
$ (anyOf 1).created_timestamp (anyOf 1) | string | Alternative | |
$ (anyOf 1).created_timestamp (anyOf 2) | null | Alternative | |
$ (anyOf 1).client_modified | string | Required within parent | |
$ (anyOf 1).server_modified | string | Required within parent | |
$ (anyOf 1).rev | string | Required within parent | Minimum length: 9 Pattern: ^(?:[0-9a-f]+)$ |
$ (anyOf 1).size | JSON | Required within parent | |
$ (anyOf 1).size (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 1).size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: folder |
$ (anyOf 2).url | string | Required within parent | |
$ (anyOf 2).id | JSON | Optional | |
$ (anyOf 2).id (anyOf 1) | string | Alternative | Minimum length: 1 |
$ (anyOf 2).id (anyOf 2) | null | Alternative | |
$ (anyOf 2).name | string | Required within parent | |
$ (anyOf 2).expires | JSON | Optional | |
$ (anyOf 2).expires (anyOf 1) | string | Alternative | |
$ (anyOf 2).expires (anyOf 2) | null | Alternative | |
$ (anyOf 2).path_lower | JSON | Optional | |
$ (anyOf 2).path_lower (anyOf 1) | string | Alternative | |
$ (anyOf 2).path_lower (anyOf 2) | null | Alternative | |
$ (anyOf 2).link_permissions | Model | Required within parent | Expand Get the shared link's metadata — response body — tag file link permissions |
$ (anyOf 2).team_member_info | JSON | Optional | |
$ (anyOf 2).team_member_info (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
$ (anyOf 2).content_owner_team_info | JSON | Optional | |
$ (anyOf 2).content_owner_team_info (anyOf 1) | Model | Alternative | Expand Update the viewer info policy of a file — response body — owner team Information about a team |
$ (anyOf 2).content_owner_team_info (anyOf 2) | null | Alternative | |
$ (anyOf 2).preview_type | JSON | Optional | |
$ (anyOf 2).preview_type (anyOf 1) | string | Alternative | |
$ (anyOf 2).preview_type (anyOf 2) | null | Alternative | |
$ (anyOf 2).created_timestamp | JSON | Optional | |
$ (anyOf 2).created_timestamp (anyOf 1) | string | Alternative | |
$ (anyOf 2).created_timestamp (anyOf 2) | null | Alternative | |
$ (anyOf 3) | object | Alternative | The metadata of a shared link. |
$ (anyOf 3).url | string | Required within parent | |
$ (anyOf 3).id | JSON | Optional | |
$ (anyOf 3).id (anyOf 1) | string | Alternative | Minimum length: 1 |
$ (anyOf 3).id (anyOf 2) | null | Alternative | |
$ (anyOf 3).name | string | Required within parent | |
$ (anyOf 3).expires | JSON | Optional | |
$ (anyOf 3).expires (anyOf 1) | string | Alternative | |
$ (anyOf 3).expires (anyOf 2) | null | Alternative | |
$ (anyOf 3).path_lower | JSON | Optional | |
$ (anyOf 3).path_lower (anyOf 1) | string | Alternative | |
$ (anyOf 3).path_lower (anyOf 2) | null | Alternative | |
$ (anyOf 3).link_permissions | Model | Required within parent | Expand Get the shared link's metadata — response body — tag file link permissions |
$ (anyOf 3).team_member_info | JSON | Optional | |
$ (anyOf 3).team_member_info (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
$ (anyOf 3).content_owner_team_info | JSON | Optional | |
$ (anyOf 3).content_owner_team_info (anyOf 1) | Model | Alternative | Expand Update the viewer info policy of a file — response body — owner team Information about a team |
$ (anyOf 3).content_owner_team_info (anyOf 2) | null | Alternative | |
$ (anyOf 3).preview_type | JSON | Optional | |
$ (anyOf 3).preview_type (anyOf 1) | string | Alternative | |
$ (anyOf 3).preview_type (anyOf 2) | null | Alternative | |
$ (anyOf 3).created_timestamp | JSON | Optional | |
$ (anyOf 3).created_timestamp (anyOf 1) | string | Alternative | |
$ (anyOf 3).created_timestamp (anyOf 2) | null | Alternative | |
$ (anyOf 3)..tag | string | Optional | Pattern: ^(?!(?: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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | check documentation for VisibilityPolicyDisallowedReason. |
$ (anyOf 1) | string | Alternative | Known values: delete_and_recreate, restricted_by_shared_folder, restricted_by_team, user_not_on_team, user_account_type, permission_denied |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: delete_and_recreate |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: restricted_by_shared_folder |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: restricted_by_team |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: user_not_on_team |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: user_account_type |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: permission_denied |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Enumerates acceptable values for team's ChangeLinkExpirationPolicy setting. |
$ (anyOf 1) | string | Alternative | Known values: allowed, not_allowed |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: allowed |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: not_allowed |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:allowed|not_allowed)$) |
Get the shared link's metadata — response body — tag file link permissions link access level value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: viewer, editor |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: viewer |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: editor |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:viewer|editor)$) |
Get the shared link's metadata — response body — tag file link permissions requested visibility value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the ResolvedVisibility for more info on the possible resolved visibility values of shared links. |
$ (anyOf 1) | string | Alternative | Known values: public, team_only, password |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: public |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: team_only |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: password |
Get the shared link's metadata — response body — tag file link permissions resolved visibility value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the RequestedVisibility for more info on the possible visibility values that can be set by the shared link's owner. |
$ (anyOf 1) | string | Alternative | Known values: public, team_only, password, team_and_password, shared_folder_only, no_one, only_you |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: public |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: team_only |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: password |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: team_and_password |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: shared_folder_only |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: no_one |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: only_you |
$ (anyOf 9) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 9)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: login_required, email_verify_required, password_required, team_only, owner_only |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: login_required |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: email_verify_required |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: password_required |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: team_only |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: owner_only |
$ (anyOf 7) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 7)..tag | string | Required within parent | Pattern: ^(?!(?: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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: delete_and_recreate, restricted_by_shared_folder, restricted_by_team, user_not_on_team, user_account_type, permission_denied |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: delete_and_recreate |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: restricted_by_shared_folder |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: restricted_by_team |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: user_not_on_team |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: user_account_type |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: permission_denied |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | check documentation for ResolvedVisibility. |
$ (anyOf 1) | string | Alternative | Known values: public, team_only, password, team_and_password, shared_folder_only, no_one, only_you |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: public |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: team_only |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: password |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: team_and_password |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: shared_folder_only |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: no_one |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: only_you |
$ (anyOf 9) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 9)..tag | string | Required within parent | Pattern: ^(?!(?: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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | JSON | Optional | |
path (anyOf 1) | string | Alternative | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
path (anyOf 2) | null | Alternative | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | |
cursor (anyOf 2) | null | Alternative | |
direct_only | JSON | Optional | |
direct_only (anyOf 1) | boolean | Alternative | |
direct_only (anyOf 2) | null | Alternative | |
List shared links of this user — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
links | array | Required within parent | |
links[] | Model | Each item | Expand Get the shared link's metadata — response body |
has_more | boolean | Required within parent | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | |
cursor (anyOf 2) | null | Alternative | |
Referenced models: Get the shared link's metadata — response body
Modify the shared link's settings — request body — body
Referenced models: Modify the shared link's settings — request body — body settings
Modify the shared link's settings — request body — body settings
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: viewer, editor, max, default |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: viewer |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: editor |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: max |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: default |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:viewer|editor|max|default)$) |
Modify the shared link's settings — request body — body settings audience value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: public, team, no_one, password, members, public_logged_in_only |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: public |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: team |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: no_one |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: password |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: members |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: public_logged_in_only |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?:public|team|no_one|password|members|public_logged_in_only)$) |
Modify the shared link's settings — request body — body settings requested visibility value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the ResolvedVisibility for more info on the possible resolved visibility values of shared links. |
$ (anyOf 1) | string | Alternative | One of: public, team_only, password |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: public |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: team_only |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Arguments for list_file_members/continue. |
cursor | string | Required within parent | |
Remove all members from this file — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Arguments for unshare_file. |
file | string | Required within parent | Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$ |
Removes a specified member from the file — request body — body
Referenced models: Removes a specified member from the file — request body — body member
Removes a specified member from the file — request body — body member
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Includes different ways to identify a member of a shared folder. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: dropbox_id |
$ (anyOf 1).dropbox_id | string | Required within parent | Minimum length: 1 |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: email |
$ (anyOf 2).email | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:dropbox_id|email)$) |
Removes a specified member from the file — response body
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: invalid_member, no_permission |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: invalid_member |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: no_permission |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: access_error |
$ (anyOf 4).access_error | Model | Required within parent | Expand Get members of multiple files at once — response body — item result tag access error access error |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: no_explicit_access |
$ (anyOf 5).access_level | JSON | Optional | |
$ (anyOf 5).access_level (anyOf 1) | Model | Alternative | Expand The current user mounts the designated folder — response body — access type |
$ (anyOf 5).access_level (anyOf 2) | null | Alternative | |
$ (anyOf 5).warning | JSON | Optional | |
$ (anyOf 5).warning (anyOf 1) | string | Alternative | |
$ (anyOf 5).warning (anyOf 2) | null | Alternative | |
$ (anyOf 5).access_details | JSON | Optional | |
$ (anyOf 5).access_details (anyOf 1) | array | Alternative | |
$ (anyOf 5).access_details (anyOf 1)[] | Model | Each item | Expand Removes a specified member from the file — response body — tag success access details array item |
$ (anyOf 5).access_details (anyOf 2) | null | Alternative | |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?: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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Result for list_folders or list_mountable_folders, depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.path_lower. |
entries | array | Required within parent | |
entries[] | Model | Each item | Expand The current user mounts the designated folder — response body |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | |
cursor (anyOf 2) | null | Alternative | |
Referenced models: The current user mounts the designated folder — response body
Returns a list of all files shared with current user — request body — body
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
Referenced models: Update the viewer info policy of a file — response body
Returns shared file metadata — sharing get File Metadata Batch — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Arguments of get_file_metadata/batch. |
files | array | Required within parent | Maximum items: 100 |
files[] | string | Each item | Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$ |
actions | JSON | Optional | |
actions (anyOf 1) | array | Alternative | |
actions (anyOf 1)[] | Model | Each item | Expand Update the viewer info policy of a file — request body — body actions array item |
actions (anyOf 2) | null | Alternative | |
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
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
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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Actions that may be taken on members of a shared folder. |
$ (anyOf 1) | string | Alternative | One of: leave_a_copy, make_editor, make_owner, make_viewer, make_viewer_no_comment, remove |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: leave_a_copy |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: make_editor |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: make_owner |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: make_viewer |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: make_viewer_no_comment |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: remove |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?:leave_a_copy|make_editor|make_owner|make_viewer|make_viewer_no_comment|remove)$) |
Returns shared folder membership by its folder ID — response body
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder. |
group_name | string | Required within parent | |
group_id | string | Required within parent | |
group_external_id | JSON | Optional | |
group_external_id (anyOf 1) | string | Alternative | |
group_external_id (anyOf 2) | null | Alternative | |
member_count | JSON | Optional | |
member_count (anyOf 1) | JSON | Alternative | |
member_count (anyOf 1) (anyOf 1) | integer | Alternative | Minimum: 0 |
member_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
member_count (anyOf 2) | null | Alternative | |
group_management_type | Model | Required within parent | Expand Updates a group's name and or external ID — response body — group management type |
group_type | Model | Required within parent | Expand Returns shared folder membership by its folder ID — response body — groups item group group type |
is_member | boolean | Required within parent | |
is_owner | boolean | Required within parent | |
same_team | boolean | Required 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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The group type determines how a group is created and managed. |
$ (anyOf 1) | string | Alternative | Known values: team, user_managed |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: team |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: user_managed |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:team|user_managed)$) |
Returns shared folder membership by its folder ID — response body — invitees item
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Information about the recipient of a shared content invitation. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: email |
$ (anyOf 1).email | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:email)$) |
Returns shared folder membership by its folder ID — response body — users item
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Actions that may be taken on members of a shared folder. |
$ (anyOf 1) | string | Alternative | Known values: leave_a_copy, make_editor, make_owner, make_viewer, make_viewer_no_comment, remove |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: leave_a_copy |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: make_editor |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: make_owner |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: make_viewer |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: make_viewer_no_comment |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: remove |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Basic information about a user. Use users.get_account and users.get_account_batch to obtain more detailed information. |
account_id | string | Required within parent | Maximum length: 40 Minimum length: 40 |
email | string | Required within parent | |
display_name | string | Required within parent | |
same_team | boolean | Required within parent | |
team_member_id | JSON | Optional | |
team_member_id (anyOf 1) | string | Alternative | |
team_member_id (anyOf 2) | null | Alternative | |
Returns shared folder metadata by its folder ID — request body — body
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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | There is an error accessing the shared folder. |
$ (anyOf 1) | string | Alternative | Known values: invalid_id, not_a_member, invalid_member, email_unverified, unmounted |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: invalid_id |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: not_a_member |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: invalid_member |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: email_unverified |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: unmounted |
$ (anyOf 7) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 7)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: invalid_dropbox_id, not_a_member |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: invalid_dropbox_id |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: not_a_member |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: no_explicit_access |
$ (anyOf 4).access_level | JSON | Optional | |
$ (anyOf 4).access_level (anyOf 1) | Model | Alternative | Expand The current user mounts the designated folder — response body — access type |
$ (anyOf 4).access_level (anyOf 2) | null | Alternative | |
$ (anyOf 4).warning | JSON | Optional | |
$ (anyOf 4).warning (anyOf 1) | string | Alternative | |
$ (anyOf 4).warning (anyOf 2) | null | Alternative | |
$ (anyOf 4).access_details | JSON | Optional | |
$ (anyOf 4).access_details (anyOf 1) | array | Alternative | |
$ (anyOf 4).access_details (anyOf 1)[] | Model | Each item | Expand Removes a specified member from the file — response body — tag success access details array item |
$ (anyOf 4).access_details (anyOf 2) | null | Alternative | |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?: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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known 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) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: is_file |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: inside_shared_folder |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: contains_shared_folder |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: contains_app_folder |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: contains_team_folder |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: is_app_folder |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: inside_app_folder |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: is_public_folder |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: inside_public_folder |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: already_shared |
$ (anyOf 11).access_type | Model | Required within parent | Expand The current user mounts the designated folder — response body — access type |
$ (anyOf 11).is_inside_team_folder | boolean | Required within parent | |
$ (anyOf 11).is_team_folder | boolean | Required within parent | |
$ (anyOf 11).owner_display_names | JSON | Optional | |
$ (anyOf 11).owner_display_names (anyOf 1) | array | Alternative | |
$ (anyOf 11).owner_display_names (anyOf 1)[] | string | Each item | |
$ (anyOf 11).owner_display_names (anyOf 2) | null | Alternative | |
$ (anyOf 11).owner_team | JSON | Optional | |
$ (anyOf 11).owner_team (anyOf 1) | Model | Alternative | Expand Update the viewer info policy of a file — response body — owner team Information about a team |
$ (anyOf 11).owner_team (anyOf 2) | null | Alternative | |
$ (anyOf 11).parent_shared_folder_id | JSON | Optional | |
$ (anyOf 11).parent_shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 11).parent_shared_folder_id (anyOf 2) | null | Alternative | |
$ (anyOf 11).path_display | JSON | Optional | |
$ (anyOf 11).path_display (anyOf 1) | string | Alternative | |
$ (anyOf 11).path_display (anyOf 2) | null | Alternative | |
$ (anyOf 11).path_lower | JSON | Optional | |
$ (anyOf 11).path_lower (anyOf 1) | string | Alternative | |
$ (anyOf 11).path_lower (anyOf 2) | null | Alternative | |
$ (anyOf 11).parent_folder_name | JSON | Optional | |
$ (anyOf 11).parent_folder_name (anyOf 1) | string | Alternative | |
$ (anyOf 11).parent_folder_name (anyOf 2) | null | Alternative | |
$ (anyOf 11).link_metadata | JSON | Optional | |
$ (anyOf 11).link_metadata (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
$ (anyOf 11).name | string | Required within parent | |
$ (anyOf 11).permissions | JSON | Optional | |
$ (anyOf 11).permissions (anyOf 1) | array | Alternative | |
$ (anyOf 11).permissions (anyOf 1)[] | Model | Each item | Expand The current user mounts the designated folder — response body — permissions array item |
$ (anyOf 11).permissions (anyOf 2) | null | Alternative | |
$ (anyOf 11).policy | Model | Required within parent | Expand Update the viewer info policy of a file — response body — policy |
$ (anyOf 11).preview_url | string | Required within parent | |
$ (anyOf 11).shared_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 11).time_invited | string | Required within parent | |
$ (anyOf 11).access_inheritance | Model | Optional | Expand The current user mounts the designated folder — response body — access inheritance |
$ (anyOf 11).folder_id | JSON | Optional | |
$ (anyOf 11).folder_id (anyOf 1) | string | Alternative | Minimum length: 4 Pattern: ^(?:id:.+)$ |
$ (anyOf 11).folder_id (anyOf 2) | null | Alternative | |
$ (anyOf 12) | object | Alternative | |
$ (anyOf 12)..tag | string | Required within parent | Must equal: invalid_path |
$ (anyOf 13) | object | Alternative | |
$ (anyOf 13)..tag | string | Required within parent | Must equal: is_osx_package |
$ (anyOf 14) | object | Alternative | |
$ (anyOf 14)..tag | string | Required within parent | Must equal: inside_osx_package |
$ (anyOf 15) | object | Alternative | |
$ (anyOf 15)..tag | string | Required within parent | Must equal: is_vault |
$ (anyOf 16) | object | Alternative | |
$ (anyOf 16)..tag | string | Required within parent | Must equal: is_vault_locked |
$ (anyOf 17) | object | Alternative | |
$ (anyOf 17)..tag | string | Required within parent | Must equal: is_family |
$ (anyOf 18) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 18)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | This operation would exceed the maximum number of mounts allowed. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: total_mounts_exceeded |
$ (anyOf 1).limit | JSON | Required within parent | |
$ (anyOf 1).limit (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 1).limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).current_count | JSON | Required within parent | |
$ (anyOf 1).current_count (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 1).current_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).new_count | JSON | Required within parent | |
$ (anyOf 1).new_count (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 1).new_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: home_mounts_exceeded |
$ (anyOf 2).limit | JSON | Required within parent | |
$ (anyOf 2).limit (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).current_count | JSON | Required within parent | |
$ (anyOf 2).current_count (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).current_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).new_count | JSON | Required within parent | |
$ (anyOf 2).new_count (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).new_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: tree_size_exceeded |
$ (anyOf 3).limit | JSON | Required within parent | |
$ (anyOf 3).limit (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 3).limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).current_count | JSON | Required within parent | |
$ (anyOf 3).current_count (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 3).current_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).new_count | JSON | Required within parent | |
$ (anyOf 3).new_count (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 3).new_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:total_mounts_exceeded|home_mounts_exceeded|tree_size_exceeded)$) |
Returns the status of an asynchronous job — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: in_progress, complete |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: in_progress |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: complete |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: failed |
$ (anyOf 4).failed | Model | Required within parent | Expand 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: folder_owner, mounted, group_access, team_folder, no_permission, no_explicit_access |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: access_error |
$ (anyOf 2).access_error | Model | Required within parent | Expand 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) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: folder_owner |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: mounted |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: group_access |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: team_folder |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: no_permission |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: no_explicit_access |
$ (anyOf 9) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 9)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: team_folder, no_permission, too_many_files |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: access_error |
$ (anyOf 2).access_error | Model | Required within parent | Expand 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) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: team_folder |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: no_permission |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: too_many_files |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
url | string | Required within parent | |
Share a folder with collaborators — request body — body
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Information about the inheritance policy of a shared folder. |
$ (anyOf 1) | string | Alternative | One of: inherit, no_inherit |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: inherit |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: no_inherit |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:inherit|no_inherit)$) |
Share a folder with collaborators — request body — body acl update policy value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Who 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) | string | Alternative | One of: owner, editors |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: owner |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: editors |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:owner|editors)$) |
Share a folder with collaborators — request body — body actions array item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Actions that may be taken on shared folders. |
$ (anyOf 1) | string | Alternative | One 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) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: change_options |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: disable_viewer_info |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: edit_contents |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: enable_viewer_info |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: invite_editor |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: invite_viewer |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: invite_viewer_no_comment |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: relinquish_membership |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: unmount |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: unshare |
$ (anyOf 12) | object | Alternative | |
$ (anyOf 12)..tag | string | Required within parent | Must equal: leave_a_copy |
$ (anyOf 13) | object | Alternative | |
$ (anyOf 13)..tag | string | Required within parent | Must equal: share_link |
$ (anyOf 14) | object | Alternative | |
$ (anyOf 14)..tag | string | Required within parent | Must equal: create_link |
$ (anyOf 15) | object | Alternative | |
$ (anyOf 15)..tag | string | Required within parent | Must equal: create_view_link |
$ (anyOf 16) | object | Alternative | |
$ (anyOf 16)..tag | string | Required within parent | Must equal: create_edit_link |
$ (anyOf 17) | object | Alternative | |
$ (anyOf 17)..tag | string | Required within parent | Must equal: set_access_inheritance |
$ (anyOf 18) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 18)..tag | string | Required within parent | Pattern: ^(?!(?: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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Defines the access levels for collaborators. |
$ (anyOf 1) | string | Alternative | One of: owner, editor, viewer, viewer_no_comment, traverse, no_access |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: owner |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: editor |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: viewer |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: viewer_no_comment |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: traverse |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: no_access |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?: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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: remove_expiry |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: remove_expiry |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: set_expiry |
$ (anyOf 3).set_expiry | string | Required within parent | |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:remove_expiry|set_expiry)$) |
Share a folder with collaborators — request body — body link settings Settings that apply to a link password value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: remove_password |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: remove_password |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: set_password |
$ (anyOf 3).set_password | string | Required within parent | |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:remove_password|set_password)$) |
Share a folder with collaborators — request body — body member policy value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team. |
$ (anyOf 1) | string | Alternative | One of: team, anyone, team_and_approved |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: team |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: anyone |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: team_and_approved |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:team|anyone|team_and_approved)$) |