Modify Shared Link Settings

POST

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

POST

/2/sharing/modify_shared_link_settings

import requests
url = "https://api.dropboxapi.com/2/sharing/modify_shared_link_settings"
payload = {
    "settings": {
        "access": { ".tag": "viewer" },
        "allow_download": True,
        "audience": { ".tag": "public" },
        "requested_visibility": { ".tag": "public" }
    },
    "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0"
}
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

{
  ".tag": "file",
  "client_modified": "2015-05-12T15:50:38Z",
  "id": "id:a4ayc_80_OEAAAAAAAAAXw",
  "link_permissions": {
    "allow_comments": true,
    "allow_download": true,
    "audience_options": [
      {
        "allowed": true,
        "audience": {
          ".tag": "public"
        }
      },
      {
        "allowed": false,
        "audience": {
          ".tag": "team"
        }
      },
      {
        "allowed": true,
        "audience": {
          ".tag": "no_one"
        }
      }
    ],
    "can_allow_download": true,
    "can_disallow_download": false,
    "can_remove_expiry": false,
    "can_remove_password": true,
    "can_revoke": false,
    "can_set_expiry": false,
    "can_set_password": true,
    "can_use_extended_sharing_controls": false,
    "require_password": false,
    "resolved_visibility": {
      ".tag": "public"
    },
    "revoke_failure_reason": {
      ".tag": "owner_only"
    },
    "team_restricts_comments": true,
    "visibility_policies": [
      {
        "allowed": true,
        "policy": {
          ".tag": "public"
        },
        "resolved_policy": {
          ".tag": "public"
        }
      },
      {
        "allowed": true,
        "policy": {
          ".tag": "password"
        },
        "resolved_policy": {
          ".tag": "password"
        }
      }
    ]
  },
  "name": "Prime_Numbers.txt",
  "path_lower": "/homework/math/prime_numbers.txt",
  "rev": "a1c10ce0dd78",
  "server_modified": "2015-05-12T15:50:38Z",
  "size": 7212,
  "team_member_info": {
    "display_name": "Roger Rabbit",
    "member_id": "dbmid:abcd1234",
    "team_info": {
      "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
      "name": "Acme, Inc."
    }
  },
  "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0"
}

Modify the shared link’s settings. If the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the LinkPermissions.resolved_visibility of the returned SharedLinkMetadata will reflect the actual visibility of the shared link and the LinkPermissions.requested_visibility will reflect the requested visibility.

Required scope: sharing.write

Endpoint format: RPC

Authentication: User

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.

settingsobjectRequired

Set of settings for the shared link.

urlstringRequired

URL of the shared link to change its settings.

remove_expirationbooleanOptional

If set to true, removes the expiration of the shared link.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

Variant:

sharing_apiv2.SharedLinkMetadata.fileobject

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error