Share Folder | Dropbox API Documentation

import requests
url = "https://api.dropboxapi.com/2/sharing/share_folder"
payload = {
    "path": "/example/workspace",
    "acl_update_policy": { ".tag": "editors" },
    "member_policy": { ".tag": "team" },
    "shared_link_policy": { ".tag": "members" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  ".tag": "complete",
  "access_inheritance": {
    ".tag": "inherit"
  },
  "access_type": {
    ".tag": "owner"
  },
  "folder_id": "id:a4ayc_80_OEAAAAAAAAAXw",
  "is_inside_team_folder": false,
  "is_team_folder": false,
  "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": ""
  },
  "name": "dir",
  "owner_display_names": [
    "Jane Doe"
  ],
  "owner_team": {
    "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
    "name": "Acme, Inc."
  },
  "parent_folder_name": "Parent Shared Folder",
  "path_lower": "/dir",
  "permissions": [],
  "policy": {
    "acl_update_policy": {
      ".tag": "owner"
    },
    "member_policy": {
      ".tag": "anyone"
    },
    "resolved_member_policy": {
      ".tag": "team"
    },
    "shared_link_policy": {
      ".tag": "anyone"
    }
  },
  "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf",
  "shared_folder_id": "84528192421",
  "time_invited": "2016-01-20T00:00:00Z"
}

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.

Required scope: sharing.write

Endpoint format: RPC

Authentication: User, Dropbox-API-Select-Admin (Team Admin)

This endpoint does not support apps with the app folder permission.

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Headers

Request

This endpoint expects an object.

pathstringRequiredformat: "(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*)"

The path or the file id to the folder to share. If it does not exist, then a new one is created.

access_inheritanceobject or nullOptional

The access inheritance settings for the folder.

Variant:

sharing_apiv2.AccessInheritance.inheritobjectRequired

The shared folder inherits its members from the parent folder.

acl_update_policyobject or nullOptional

Who can add and remove members of this shared folder.

Variant:

sharing_apiv2.AclUpdatePolicy.ownerobjectRequired

Only the owner can update the ACL.

actionslist of objects or nullOptional

A list of FolderActions corresponding to FolderPermissions that should appear in the response’s SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.

Variant:

sharing_apiv2.FolderAction.change_optionsobjectRequired

Change folder options, such as who can be invited to join the folder.

force_asyncbooleanOptional

Whether to force the share to happen asynchronously.

link_settingsobject or nullOptional

Settings on the link for this folder.

member_policyobject or nullOptional

Who can be a member of this shared folder. Only applicable if the current user is on a team.

Variant:

sharing_apiv2.MemberPolicy.teamobjectRequired

Only a teammate can become a member.

shared_link_policyobject or nullOptional

The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.

Variant:

sharing_apiv2.SharedLinkPolicy.anyoneobjectRequired

Links can be shared with anyone.

viewer_info_policyobject or nullOptional

Who can enable/disable viewer info for this shared folder.

Variant:

sharing_apiv2.ViewerInfoPolicy.enabledobjectRequired

Viewer information is available on this file.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

Variant:

sharing_apiv2.ShareFolderLaunch.async_job_idobject

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error