share_folder
POST https://api.dropboxapi.com/2/sharing/share_folder
scope: sharing.write
Share a folder with collaborators.
Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set ShareFolderArg.force_async
.
If a ShareFolderLaunch.async_job_id
is returned, you'll need to call check_share_job_status
until the action completes to get the metadata for the folder.
Request Body
{"path"=>"/example/workspace", "acl_update_policy"=>"editors", "force_async"=>false, "member_policy"=>"team", "shared_link_policy"=>"members", "access_inheritance"=>"inherit"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Dropbox-API-Path-Root | string | ||
Dropbox-API-Select-User | string | ||
Dropbox-API-Select-Admin | string |
RESPONSES
status: OK
{".tag":"complete","access_type":{".tag":"owner"},"is_inside_team_folder":false,"is_team_folder":false,"name":"dir","policy":{"acl_update_policy":{".tag":"owner"},"shared_link_policy":{".tag":"anyone"},"member_policy":{".tag":"anyone"},"resolved_member_policy":{".tag":"team"}},"preview_url":"https://www.dropbox.com/scl/fo/fir9vjelf","shared_folder_id":"84528192421","time_invited":"2016-01-20T00:00:00Z","path_lower":"/dir","link_metadata":{"audience_options":[{".tag":"public"},{".tag":"team"},{".tag":"members"}],"current_audience":{".tag":"public"},"link_permissions":[{"action":{".tag":"change_audience"},"allow":true}],"password_protected":false,"url":""},"permissions":[],"access_inheritance":{".tag":"inherit"}}