Dropbox: Update the viewer info policy of a file

Dropbox sharing.updateFilePolicy: arguments, response, policy and SDK examples.

Operation dropbox.sharing_update_file_policy

Provider route: POST /2/sharing/update_file_policy. Alter supplies the connection’s credentials and routing.

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"]["updateFilePolicy"]>[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.updateFilePolicy(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.update_file_policy(arguments)
        result = await call.wait()
        return result.body_json()

Input

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 Update the viewer info policy of a file — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Update the viewer info policy of a file — request body — body

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

Referenced models: Update the viewer info policy of a file — response body

Schemas

23 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)$)

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 — 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

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)$)

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 — 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

Policy, approvals and errors

SDK function policy ID: dropbox.sharing_update_file_policy. Catalog operation: sharing/update_file_policy. 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"]

Official provider source

Report an issue with this page