Dropbox: Removes a specified member from the file
Dropbox sharing.removeFileMember2: arguments, response, policy and SDK examples.
← Sharing operations · Get started
Operation dropbox.sharing_remove_file_member_2
Provider route: POST /2/sharing/remove_file_member_2. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DropboxIntegration } from "@alter-ai/dropbox";
async function execute(input: Parameters<DropboxIntegration["sharing"]["removeFileMember2"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.sharing.removeFileMember2(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_dropbox import DropboxIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.sharing.remove_file_member_2(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Dropbox-API-Path-Root | Model | Optional | Expand Deletes a group — request body — headers Dropbox-API-Path-Root |
headers.Dropbox-API-Select-User | string | Optional | |
headers.Dropbox-API-Select-Admin | string | Optional | |
body | Model | Required within parent | Expand Removes a specified member from the file — request body — body |
Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Removes a specified member from the file — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Removes a specified member from the file — response body |
Referenced models: Removes a specified member from the file — response body
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Deletes a group — request body — headers Dropbox-API-Path-Root
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: home |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: home |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: root |
$ (anyOf 3).root | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: namespace_id |
$ (anyOf 4).namespace_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:home|root|namespace_id)$) |
Removes a specified member from the file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: success |
$ (anyOf 1).access_level | JSON | Optional | |
$ (anyOf 1).access_level (anyOf 1) | Model | Alternative | Expand The current user mounts the designated folder — response body — access type |
$ (anyOf 1).access_level (anyOf 2) | null | Alternative | |
$ (anyOf 1).warning | JSON | Optional | |
$ (anyOf 1).warning (anyOf 1) | string | Alternative | |
$ (anyOf 1).warning (anyOf 2) | null | Alternative | |
$ (anyOf 1).access_details | JSON | Optional | |
$ (anyOf 1).access_details (anyOf 1) | array | Alternative | |
$ (anyOf 1).access_details (anyOf 1)[] | Model | Each item | Expand Removes a specified member from the file — response body — tag success access details array item |
$ (anyOf 1).access_details (anyOf 2) | null | Alternative | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: member_error |
$ (anyOf 2).member_error | Model | Required within parent | Expand Removes a specified member from the file — response body — tag member error member error |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:success|member_error)$) |
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 — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Arguments for remove_file_member_2. |
file | string | Required within parent | Minimum length: 1 Pattern: ^(?:((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?)$ |
member | Model | Required within parent | Expand Removes a specified member from the file — request body — body member |
Referenced models: Removes a specified member from the file — request body — body member
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)$) |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about a parent folder that a member has access to. |
folder_name | string | Required within parent | |
shared_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
permissions | array | Required within parent | |
permissions[] | Model | Each item | Expand Returns shared folder membership by its folder ID — response body — users item permissions array item |
path | string | Required within parent |
Referenced models: Returns shared folder membership by its folder ID — response body — users item permissions array item
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)$) |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.sharing_remove_file_member_2. Catalog operation: sharing/remove_file_member_2. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["sharing.write"]