Set Access Inheritance

POST

https://api.dropboxapi.com/2/sharing/set_access_inheritance

POST

/2/sharing/set_access_inheritance

import requests
url = "https://api.dropboxapi.com/2/sharing/set_access_inheritance"
payload = {
    "shared_folder_id": None,
    "access_inheritance": { ".tag": "inherit" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  ".tag": "async_job_id",
  "access_inheritance": {
    ".tag": "inherit"
  },
  "access_type": {
    ".tag": "owner"
  },
  "async_job_id": "string",
  "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"
}

Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root.

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

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

Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root. If a `ShareFolderLaunch.async_job_id` is returned, you'll need to call [check_share_job_status](api:dropbox-api:POST/2/sharing/check_share_job_status) until the action completes to get the metadata for the folder. **Required scope:** `sharing.write` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [User](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#user-authentication) 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.

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](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Headers

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the `common.PathRoot` union: `{".tag": "home"}`, `{".tag": "root", "root": "<namespace_id>"}`, or `{".tag": "namespace_id", "namespace_id": "<namespace_id>"}`. On failure the request returns 422 with a `common.PathRootError`.

Request

This endpoint expects an object.

shared_folder_idanyRequired

The ID for the shared folder.

access_inheritanceobject or nullOptional

The access inheritance settings for the folder.

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