Update File Policy

POST

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

POST

/2/sharing/update_file_policy

import requests
url = "https://api.dropboxapi.com/2/sharing/update_file_policy"
payload = { "file": "/root/word.docx" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "id": "id:3kmLmQFnf1AAAAAAAAAAAw",
  "name": "file.txt",
  "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/fi/fir9vjelf",
  "access_type": {
    ".tag": "viewer"
  },
  "owner_display_names": [
    "Jane Doe"
  ],
  "owner_team": {
    "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
    "name": "Acme, Inc."
  },
  "path_display": "/dir/file.txt",
  "path_lower": "/dir/file.txt",
  "permissions": [],
  "time_invited": "2016-01-20T00:00:00Z"
}

Update the viewer info policy of a file.

Required scope: sharing.write

Endpoint format: RPC

Authentication: User

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.

filestringRequiredformat: "((\/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?">=1 character

File that we are changing the policy for.

actionslist of objects or nullOptional

A list of FileActions corresponding to FilePermissions that should appear in the response’s SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.

Variant:

sharing_apiv2.FileAction.disable_viewer_infoobjectRequired

Disable viewer information on the file.

viewer_info_policyobject or nullOptional

The presence and seen state policy on the file.

Variant:

sharing_apiv2.ViewerInfoPolicy.enabledobjectRequired

Viewer information is available on this file.

link_settingsobject or nullOptionalDeprecated

Settings on the link for the file.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

idstringformat: "id:.+">=4 characters

The ID of the file.

namestring

The name of this file.

policyobject

Policies governing this shared file.

preview_urlstring

URL for displaying a web preview of the shared file.

access_typeobject or nullOptional

The current user's access level for this shared file.

Variant:

sharing_apiv2.AccessLevel.ownerobject

The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder’s policies using update_folder_policy.

expected_link_metadataobject or nullOptional

The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.

link_metadataobject or nullOptional

The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.

owner_display_nameslist of strings or nullOptional

The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.

owner_teamobject or nullOptional

The team that owns the file. This field is not present if the file is not owned by a team.

parent_shared_folder_idstring or nullOptionalformat: "[-_0-9a-zA-Z:]+"

The ID of the parent shared folder. This field is present only if the file is contained within a shared folder.

path_displaystring or nullOptional

The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.

path_lowerstring or nullOptional

The lower-case full path of this file. Absent for unmounted files.

permissionslist of objects or nullOptional

The sharing permissions that requesting user has on this file. This corresponds to the entries given in GetFileMetadataBatchArg.actions or GetFileMetadataArg.actions.

time_inviteddatetime or nullOptional

Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error