Dropbox: Sharing schemas (part 2)

37 Dropbox schemas with complete fields and constraints.

Share a folder with collaborators — request body — body shared link policy Who can view shared links in this folder

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Who can view shared links in this folder.
`$ (anyOf 1)`	string	Alternative	One of: anyone, team, members
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: anyone
`$ (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: members
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:anyone\|team\|members)$)

Share a folder with collaborators — request body — body viewer info policy value

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	One of: enabled, disabled
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: enabled
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: disabled
`$ (anyOf 4)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 4)..tag`	string	Required within parent	Pattern: ^(?!(?:enabled\|disabled)$)

Share a folder with collaborators — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: async_job_id
`$ (anyOf 1).async_job_id`	string	Required within parent	Minimum length: 1
`$ (anyOf 2)`	Model	Alternative	Expand Share a folder with collaborators — response body — tag complete

Referenced models: Share a folder with collaborators — response body — tag complete

Share a folder with collaborators — response body — tag complete

Field	Type	Presence	Description and constraints
`$`	object	Root
`.tag`	string	Required within parent	Must equal: complete
`access_type`	Model	Required within parent	Expand The current user mounts the designated folder — response body — access type
`is_inside_team_folder`	boolean	Required within parent
`is_team_folder`	boolean	Required within parent
`owner_display_names`	JSON	Optional
`owner_display_names (anyOf 1)`	array	Alternative
`owner_display_names (anyOf 1)[]`	string	Each item
`owner_display_names (anyOf 2)`	null	Alternative
`owner_team`	JSON	Optional
`owner_team (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
`owner_team (anyOf 2)`	null	Alternative
`parent_shared_folder_id`	JSON	Optional
`parent_shared_folder_id (anyOf 1)`	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`parent_shared_folder_id (anyOf 2)`	null	Alternative
`path_display`	JSON	Optional
`path_display (anyOf 1)`	string	Alternative
`path_display (anyOf 2)`	null	Alternative
`path_lower`	JSON	Optional
`path_lower (anyOf 1)`	string	Alternative
`path_lower (anyOf 2)`	null	Alternative
`parent_folder_name`	JSON	Optional
`parent_folder_name (anyOf 1)`	string	Alternative
`parent_folder_name (anyOf 2)`	null	Alternative
`link_metadata`	JSON	Optional
`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
`link_metadata (anyOf 2)`	null	Alternative
`name`	string	Required within parent
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative
`permissions (anyOf 1)[]`	Model	Each item	Expand The current user mounts the designated folder — response body — permissions array item
`permissions (anyOf 2)`	null	Alternative
`policy`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — policy
`preview_url`	string	Required within parent
`shared_folder_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`time_invited`	string	Required within parent
`access_inheritance`	Model	Optional	Expand The current user mounts the designated folder — response body — access inheritance
`folder_id`	JSON	Optional
`folder_id (anyOf 1)`	string	Alternative	Minimum length: 4 Pattern: ^(?:id:.+)$
`folder_id (anyOf 2)`	null	Alternative

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

The current user mounts the designated folder — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`shared_folder_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$

The current user mounts the designated folder — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The metadata which includes basic information about the shared folder.
`access_type`	Model	Required within parent	Expand The current user mounts the designated folder — response body — access type
`is_inside_team_folder`	boolean	Required within parent
`is_team_folder`	boolean	Required within parent
`owner_display_names`	JSON	Optional
`owner_display_names (anyOf 1)`	array	Alternative
`owner_display_names (anyOf 1)[]`	string	Each item
`owner_display_names (anyOf 2)`	null	Alternative
`owner_team`	JSON	Optional
`owner_team (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
`owner_team (anyOf 2)`	null	Alternative
`parent_shared_folder_id`	JSON	Optional
`parent_shared_folder_id (anyOf 1)`	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`parent_shared_folder_id (anyOf 2)`	null	Alternative
`path_display`	JSON	Optional
`path_display (anyOf 1)`	string	Alternative
`path_display (anyOf 2)`	null	Alternative
`path_lower`	JSON	Optional
`path_lower (anyOf 1)`	string	Alternative
`path_lower (anyOf 2)`	null	Alternative
`parent_folder_name`	JSON	Optional
`parent_folder_name (anyOf 1)`	string	Alternative
`parent_folder_name (anyOf 2)`	null	Alternative
`link_metadata`	JSON	Optional
`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
`link_metadata (anyOf 2)`	null	Alternative
`name`	string	Required within parent
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative
`permissions (anyOf 1)[]`	Model	Each item	Expand The current user mounts the designated folder — response body — permissions array item
`permissions (anyOf 2)`	null	Alternative
`policy`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — policy
`preview_url`	string	Required within parent
`shared_folder_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`time_invited`	string	Required within parent
`access_inheritance`	Model	Optional	Expand The current user mounts the designated folder — response body — access inheritance
`folder_id`	JSON	Optional
`folder_id (anyOf 1)`	string	Alternative	Minimum length: 4 Pattern: ^(?:id:.+)$
`folder_id (anyOf 2)`	null	Alternative

The current user mounts the designated folder — response body — access inheritance

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Information about the inheritance policy of a shared folder.
`$ (anyOf 1)`	string	Alternative	Known values: 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)$)

The current user mounts the designated folder — response body — access type

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Defines the access levels for collaborators.
`$ (anyOf 1)`	string	Alternative	Known values: 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)$)

The current user mounts the designated folder — response body — permissions array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Whether the user is allowed to take the action on the shared folder.
`action`	Model	Required within parent	Expand The current user mounts the designated folder — response body — permissions array item action
`allow`	boolean	Required within parent
`reason`	JSON	Optional
`reason (anyOf 1)`	Model	Alternative	Expand 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)`	null	Alternative

Referenced models: The current user mounts the designated folder — response body — 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

The current user mounts the designated folder — response body — permissions array item action

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Actions that may be taken on shared folders.
`$ (anyOf 1)`	string	Alternative	Known values: 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)$)

The current user relinquishes their membership in the designated file — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`file`	string	Required within parent	Minimum length: 1 Pattern: ^(?:((\/\|id:).\|nspath:[0-9]+:.)\|ns:[0-9]+(/.*)?)$

Update the sharing policies for a shared folder — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	If any of the policies are unset, then they retain their current setting.
`shared_folder_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`member_policy`	JSON	Optional
`member_policy (anyOf 1)`	Model	Alternative	Expand Share a folder with collaborators — request body — body member policy value
`member_policy (anyOf 2)`	null	Alternative
`acl_update_policy`	JSON	Optional
`acl_update_policy (anyOf 1)`	Model	Alternative	Expand Share a folder with collaborators — request body — body acl update policy value
`acl_update_policy (anyOf 2)`	null	Alternative
`viewer_info_policy`	JSON	Optional
`viewer_info_policy (anyOf 1)`	Model	Alternative	Expand Share a folder with collaborators — request body — body viewer info policy value
`viewer_info_policy (anyOf 2)`	null	Alternative
`shared_link_policy`	JSON	Optional
`shared_link_policy (anyOf 1)`	Model	Alternative	Expand Share a folder with collaborators — request body — body shared link policy Who can view shared links in this folder
`shared_link_policy (anyOf 2)`	null	Alternative
`link_settings`	JSON	Optional
`link_settings (anyOf 1)`	Model	Alternative	Expand Share a folder with collaborators — request body — body link settings Settings that apply to a link
`link_settings (anyOf 2)`	null	Alternative
`actions`	JSON	Optional
`actions (anyOf 1)`	array	Alternative
`actions (anyOf 1)[]`	Model	Each item	Expand Share a folder with collaborators — request body — body actions array item
`actions (anyOf 2)`	null	Alternative

Referenced models: 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

Update the viewer info policy of a file — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for update_file_policy.
`file`	string	Required within parent	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
`link_settings`	JSON	Optional
`link_settings (anyOf 1)`	Model	Alternative	Expand Share a folder with collaborators — request body — body link settings Settings that apply to a link
`link_settings (anyOf 2)`	null	Alternative
`viewer_info_policy`	JSON	Optional
`viewer_info_policy (anyOf 1)`	Model	Alternative	Expand Share a folder with collaborators — request body — body viewer info policy value
`viewer_info_policy (anyOf 2)`	null	Alternative

Referenced models: Update the viewer info policy of a file — 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 viewer info policy value

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Sharing actions that may be taken on files.
`$ (anyOf 1)`	string	Alternative	One of: disable_viewer_info, edit_contents, enable_viewer_info, invite_viewer, invite_viewer_no_comment, invite_editor, unshare, relinquish_membership, share_link, create_link, create_view_link, create_edit_link
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: disable_viewer_info
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: edit_contents
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: enable_viewer_info
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: invite_viewer
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: invite_viewer_no_comment
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: invite_editor
`$ (anyOf 8)`	object	Alternative
`$ (anyOf 8)..tag`	string	Required within parent	Must equal: unshare
`$ (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: share_link
`$ (anyOf 11)`	object	Alternative
`$ (anyOf 11)..tag`	string	Required within parent	Must equal: create_link
`$ (anyOf 12)`	object	Alternative
`$ (anyOf 12)..tag`	string	Required within parent	Must equal: create_view_link
`$ (anyOf 13)`	object	Alternative
`$ (anyOf 13)..tag`	string	Required within parent	Must equal: create_edit_link
`$ (anyOf 14)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 14)..tag`	string	Required within parent	Pattern: ^(?!(?:disable_viewer_info\|edit_contents\|enable_viewer_info\|invite_viewer\|invite_viewer_no_comment\|invite_editor\|unshare\|relinquish_membership\|share_link\|create_link\|create_view_link\|create_edit_link)$)

Update the viewer info policy of a file — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Properties of the shared file.
`access_type`	JSON	Optional
`access_type (anyOf 1)`	Model	Alternative	Expand The current user mounts the designated folder — response body — access type
`access_type (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Minimum length: 4 Pattern: ^(?:id:.+)$
`expected_link_metadata`	JSON	Optional
`expected_link_metadata (anyOf 1)`	Model	Alternative	Expand 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
`expected_link_metadata (anyOf 2)`	null	Alternative
`link_metadata`	JSON	Optional
`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
`link_metadata (anyOf 2)`	null	Alternative
`name`	string	Required within parent
`owner_display_names`	JSON	Optional
`owner_display_names (anyOf 1)`	array	Alternative
`owner_display_names (anyOf 1)[]`	string	Each item
`owner_display_names (anyOf 2)`	null	Alternative
`owner_team`	JSON	Optional
`owner_team (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
`owner_team (anyOf 2)`	null	Alternative
`parent_shared_folder_id`	JSON	Optional
`parent_shared_folder_id (anyOf 1)`	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`parent_shared_folder_id (anyOf 2)`	null	Alternative
`path_display`	JSON	Optional
`path_display (anyOf 1)`	string	Alternative
`path_display (anyOf 2)`	null	Alternative
`path_lower`	JSON	Optional
`path_lower (anyOf 1)`	string	Alternative
`path_lower (anyOf 2)`	null	Alternative
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative
`permissions (anyOf 1)[]`	Model	Each item	Expand Update the viewer info policy of a file — response body — permissions array item
`permissions (anyOf 2)`	null	Alternative
`policy`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — policy
`preview_url`	string	Required within parent
`time_invited`	JSON	Optional
`time_invited (anyOf 1)`	string	Alternative
`time_invited (anyOf 2)`	null	Alternative

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, Update the viewer info policy of a file — response body — owner team Information about a team

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

Field	Type	Presence	Description and constraints
`$`	object	Root	The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.
`access_level`	JSON	Optional
`access_level (anyOf 1)`	Model	Alternative	Expand The current user mounts the designated folder — response body — access type
`access_level (anyOf 2)`	null	Alternative
`audience_options`	array	Required within parent
`audience_options[]`	Model	Each item	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience
`audience_restricting_shared_folder`	JSON	Optional
`audience_restricting_shared_folder (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 audience restricting shared folder audience, name, shared folder id
`audience_restricting_shared_folder (anyOf 2)`	null	Alternative
`current_audience`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience
`expiry`	JSON	Optional
`expiry (anyOf 1)`	string	Alternative
`expiry (anyOf 2)`	null	Alternative
`link_permissions`	array	Required within parent
`link_permissions[]`	Model	Each item	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item
`password_protected`	boolean	Required within parent

Referenced models: The current user mounts the designated folder — response body — access type, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience restricting shared folder audience, name, shared folder id, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder

Field	Type	Presence	Description and constraints
`$`	object	Root	Metadata of a shared link for a file or folder.
`access_level`	JSON	Optional
`access_level (anyOf 1)`	Model	Alternative	Expand The current user mounts the designated folder — response body — access type
`access_level (anyOf 2)`	null	Alternative
`audience_options`	array	Required within parent
`audience_options[]`	Model	Each item	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience
`audience_restricting_shared_folder`	JSON	Optional
`audience_restricting_shared_folder (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 audience restricting shared folder audience, name, shared folder id
`audience_restricting_shared_folder (anyOf 2)`	null	Alternative
`current_audience`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience
`expiry`	JSON	Optional
`expiry (anyOf 1)`	string	Alternative
`expiry (anyOf 2)`	null	Alternative
`link_permissions`	array	Required within parent
`link_permissions[]`	Model	Each item	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item
`password_protected`	boolean	Required within parent
`audience_exceptions`	JSON	Optional
`audience_exceptions (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 audience exceptions count, exceptions
`audience_exceptions (anyOf 2)`	null	Alternative
`url`	string	Required within parent

Referenced models: The current user mounts the designated folder — response body — access type, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience exceptions count, exceptions, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience restricting shared folder audience, name, shared folder id, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience exceptions count, exceptions

Field	Type	Presence	Description and constraints
`$`	object	Root	The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.
`count`	JSON	Required within parent
`count (anyOf 1)`	integer	Alternative	Minimum: 0
`count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`exceptions`	array	Required within parent
`exceptions[]`	Model	Each item	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience exceptions count, exceptions exceptions 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 audience exceptions count, exceptions exceptions item

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience exceptions count, exceptions exceptions item

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about the content that has a link audience different than that of this folder.
`name`	string	Required within parent

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder audience restricting shared folder audience, name, shared folder id

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about the shared folder that prevents the link audience for this link from being more restrictive.
`shared_folder_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`name`	string	Required within parent
`audience`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience

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

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder current audience

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	Known values: 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)$)

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item

Field	Type	Presence	Description and constraints
`$`	object	Root	Permissions for actions that can be performed on a link.
`action`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item action
`allow`	boolean	Required within parent
`reason`	JSON	Optional
`reason (anyOf 1)`	Model	Alternative	Expand 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)`	null	Alternative

Referenced models: Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item action, Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission

Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder link permissions item action

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Actions that can be performed on a link.
`$ (anyOf 1)`	string	Alternative	Known values: change_access_level, change_audience, remove_expiry, remove_password, set_expiry, set_password
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: change_access_level
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: change_audience
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: remove_expiry
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: remove_password
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: set_expiry
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: set_password
`$ (anyOf 8)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 8)..tag`	string	Required within parent	Pattern: ^(?!(?:change_access_level\|change_audience\|remove_expiry\|remove_password\|set_expiry\|set_password)$)

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about a team.
`id`	string	Required within parent
`name`	string	Required within parent

Update the viewer info policy of a file — response body — permissions array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Whether the user is allowed to take the sharing action on the file.
`action`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — permissions array item action
`allow`	boolean	Required within parent
`reason`	JSON	Optional
`reason (anyOf 1)`	Model	Alternative	Expand 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)`	null	Alternative

Referenced models: Update the viewer info policy of a file — response body — 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

Update the viewer info policy of a file — response body — permissions array item action

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Sharing actions that may be taken on files.
`$ (anyOf 1)`	string	Alternative	Known values: disable_viewer_info, edit_contents, enable_viewer_info, invite_viewer, invite_viewer_no_comment, invite_editor, unshare, relinquish_membership, share_link, create_link, create_view_link, create_edit_link
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: disable_viewer_info
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: edit_contents
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: enable_viewer_info
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: invite_viewer
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: invite_viewer_no_comment
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: invite_editor
`$ (anyOf 8)`	object	Alternative
`$ (anyOf 8)..tag`	string	Required within parent	Must equal: unshare
`$ (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: share_link
`$ (anyOf 11)`	object	Alternative
`$ (anyOf 11)..tag`	string	Required within parent	Must equal: create_link
`$ (anyOf 12)`	object	Alternative
`$ (anyOf 12)..tag`	string	Required within parent	Must equal: create_view_link
`$ (anyOf 13)`	object	Alternative
`$ (anyOf 13)..tag`	string	Required within parent	Must equal: create_edit_link
`$ (anyOf 14)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 14)..tag`	string	Required within parent	Pattern: ^(?!(?:disable_viewer_info\|edit_contents\|enable_viewer_info\|invite_viewer\|invite_viewer_no_comment\|invite_editor\|unshare\|relinquish_membership\|share_link\|create_link\|create_view_link\|create_edit_link)$)

Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Possible reasons the user is denied a permission.
`$ (anyOf 1)`	string	Alternative	Known values: user_not_same_team_as_owner, user_not_allowed_by_owner, target_is_indirect_member, target_is_owner, target_is_self, target_not_active, folder_is_limited_team_folder, owner_not_on_team, permission_denied, restricted_by_team, user_account_type, user_not_on_team, folder_is_inside_shared_folder, restricted_by_parent_folder
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: user_not_same_team_as_owner
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: user_not_allowed_by_owner
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: target_is_indirect_member
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: target_is_owner
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: target_is_self
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: target_not_active
`$ (anyOf 8)`	object	Alternative
`$ (anyOf 8)..tag`	string	Required within parent	Must equal: folder_is_limited_team_folder
`$ (anyOf 9)`	object	Alternative
`$ (anyOf 9)..tag`	string	Required within parent	Must equal: owner_not_on_team
`$ (anyOf 10)`	object	Alternative
`$ (anyOf 10)..tag`	string	Required within parent	Must equal: permission_denied
`$ (anyOf 11)`	object	Alternative
`$ (anyOf 11)..tag`	string	Required within parent	Must equal: restricted_by_team
`$ (anyOf 12)`	object	Alternative
`$ (anyOf 12)..tag`	string	Required within parent	Must equal: user_account_type
`$ (anyOf 13)`	object	Alternative
`$ (anyOf 13)..tag`	string	Required within parent	Must equal: user_not_on_team
`$ (anyOf 14)`	object	Alternative
`$ (anyOf 14)..tag`	string	Required within parent	Must equal: folder_is_inside_shared_folder
`$ (anyOf 15)`	object	Alternative
`$ (anyOf 15)..tag`	string	Required within parent	Must equal: restricted_by_parent_folder
`$ (anyOf 16)`	object	Alternative
`$ (anyOf 16)..tag`	string	Required within parent	Must equal: insufficient_plan
`$ (anyOf 16).message`	string	Required within parent
`$ (anyOf 16).upsell_url`	JSON	Optional
`$ (anyOf 16).upsell_url (anyOf 1)`	string	Alternative
`$ (anyOf 16).upsell_url (anyOf 2)`	null	Alternative
`$ (anyOf 17)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission tag

Referenced models: Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission tag

Update the viewer info policy of a file — response body — permissions array item reason Possible reasons the user is denied a permission tag

Field	Type	Presence	Description and constraints
`$`	object	Root	A tag this contract version does not list (Dropbox's other).
`.tag`	string	Required within parent	Pattern: ^(?!(?:user_not_same_team_as_owner\|user_not_allowed_by_owner\|target_is_indirect_member\|target_is_owner\|target_is_self\|target_not_active\|folder_is_limited_team_folder\|owner_not_on_team\|permission_denied\|restricted_by_team\|user_account_type\|user_not_on_team\|folder_is_inside_shared_folder\|restricted_by_parent_folder\|insufficient_plan)$)

Update the viewer info policy of a file — response body — policy

Field	Type	Presence	Description and constraints
`$`	object	Root	A set of policies governing membership and privileges for a shared folder.
`member_policy`	JSON	Optional
`member_policy (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — policy member policy value
`member_policy (anyOf 2)`	null	Alternative
`resolved_member_policy`	JSON	Optional
`resolved_member_policy (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — policy member policy value
`resolved_member_policy (anyOf 2)`	null	Alternative
`acl_update_policy`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — policy acl update policy
`shared_link_policy`	Model	Required within parent	Expand Update the viewer info policy of a file — response body — policy shared link policy
`viewer_info_policy`	JSON	Optional
`viewer_info_policy (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — policy viewer info policy value
`viewer_info_policy (anyOf 2)`	null	Alternative

Referenced models: Update the viewer info policy of a file — response body — policy acl update policy, Update the viewer info policy of a file — response body — policy member policy value, Update the viewer info policy of a file — response body — policy shared link policy, Update the viewer info policy of a file — response body — policy viewer info policy value

Update the viewer info policy of a file — response body — policy acl update policy

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	Known values: 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)$)

Update the viewer info policy of a file — response body — policy 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	Known values: 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)$)

Update the viewer info policy of a file — response body — policy shared link policy

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Who can view shared links in this folder.
`$ (anyOf 1)`	string	Alternative	Known values: anyone, team, members
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: anyone
`$ (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: members
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:anyone\|team\|members)$)

Update the viewer info policy of a file — response body — policy viewer info policy value

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	Known values: enabled, disabled
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: enabled
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: disabled
`$ (anyOf 4)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 4)..tag`	string	Required within parent	Pattern: ^(?!(?:enabled\|disabled)$)

Use to obtain the members who have been invited to a file, both inherited and uninherited members — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for list_file_members.
`file`	string	Required within parent	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 Returns shared folder membership by its folder ID — request body — body actions array item
`actions (anyOf 2)`	null	Alternative
`include_inherited`	boolean	Optional
`limit`	integer	Optional	Minimum: 1 Maximum: 300

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

Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Shared file user, group, and invitee membership. Used for the results of list_file_members and list_file_members/continue, and used as part of the results for list_file_members/batch.
`users`	array	Required within parent
`users[]`	Model	Each item	Expand Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item
`groups`	array	Required within parent
`groups[]`	Model	Each item	Expand Returns shared folder membership by its folder ID — response body — groups item
`invitees`	array	Required within parent
`invitees[]`	Model	Each item	Expand Returns shared folder membership by its folder ID — response body — invitees item
`cursor`	JSON	Optional
`cursor (anyOf 1)`	string	Alternative
`cursor (anyOf 2)`	null	Alternative

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, Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item

Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item

Field	Type	Presence	Description and constraints
`$`	object	Root	The information about a user member of the shared content with an appended last seen timestamp.
`access_type`	Model	Required within parent	Expand The current user mounts the designated folder — response body — access type
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative
`permissions (anyOf 1)[]`	Model	Each item	Expand Returns shared folder membership by its folder ID — response body — users item permissions array item
`permissions (anyOf 2)`	null	Alternative
`initials`	JSON	Optional
`initials (anyOf 1)`	string	Alternative
`initials (anyOf 2)`	null	Alternative
`is_inherited`	boolean	Optional
`inherited_access_type`	JSON	Optional
`inherited_access_type (anyOf 1)`	Model	Alternative	Expand The current user mounts the designated folder — response body — access type
`inherited_access_type (anyOf 2)`	null	Alternative
`user`	Model	Required within parent	Expand Returns shared folder membership by its folder ID — response body — users item user
`time_last_seen`	JSON	Optional
`time_last_seen (anyOf 1)`	string	Alternative
`time_last_seen (anyOf 2)`	null	Alternative
`platform_type`	JSON	Optional
`platform_type (anyOf 1)`	Model	Alternative	Expand Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item platform type value
`platform_type (anyOf 2)`	null	Alternative

Referenced models: Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item platform type value, 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

Use to obtain the members who have been invited to a file, both inherited and uninherited members — response body — users item platform type value

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Possible platforms on which a user may view content.
`$ (anyOf 1)`	string	Alternative	Known values: web, desktop, mobile_ios, mobile_android, api, unknown, mobile
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: web
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: desktop
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: mobile_ios
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: mobile_android
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: api
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: unknown
`$ (anyOf 8)`	object	Alternative
`$ (anyOf 8)..tag`	string	Required within parent	Must equal: mobile
`$ (anyOf 9)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 9)..tag`	string	Required within parent	Pattern: ^(?!(?:web\|desktop\|mobile_ios\|mobile_android\|api\|unknown\|mobile)$)

Report an issue with this page