Dropbox: Create a shared link with custom settings

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

Operation dropbox.sharing_create_shared_link_with_settings

Provider route: POST /2/sharing/create_shared_link_with_settings. 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"]["createSharedLinkWithSettings"]>[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.createSharedLinkWithSettings(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.create_shared_link_with_settings(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 Create a shared link with custom settings — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Create a shared link with custom settings — 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 Get the shared link’s metadata — response body

Referenced models: Get the shared link’s metadata — response body

Schemas

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

Get the shared link's metadata — response body

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The metadata of a shared link.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: file
`$ (anyOf 1).url`	string	Required within parent
`$ (anyOf 1).id`	JSON	Optional
`$ (anyOf 1).id (anyOf 1)`	string	Alternative	Minimum length: 1
`$ (anyOf 1).id (anyOf 2)`	null	Alternative
`$ (anyOf 1).name`	string	Required within parent
`$ (anyOf 1).expires`	JSON	Optional
`$ (anyOf 1).expires (anyOf 1)`	string	Alternative
`$ (anyOf 1).expires (anyOf 2)`	null	Alternative
`$ (anyOf 1).path_lower`	JSON	Optional
`$ (anyOf 1).path_lower (anyOf 1)`	string	Alternative
`$ (anyOf 1).path_lower (anyOf 2)`	null	Alternative
`$ (anyOf 1).link_permissions`	Model	Required within parent	Expand Get the shared link's metadata — response body — tag file link permissions
`$ (anyOf 1).team_member_info`	JSON	Optional
`$ (anyOf 1).team_member_info (anyOf 1)`	Model	Alternative	Expand Get the shared link's metadata — response body — tag file team member info Information about a team member
`$ (anyOf 1).team_member_info (anyOf 2)`	null	Alternative
`$ (anyOf 1).content_owner_team_info`	JSON	Optional
`$ (anyOf 1).content_owner_team_info (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
`$ (anyOf 1).content_owner_team_info (anyOf 2)`	null	Alternative
`$ (anyOf 1).preview_type`	JSON	Optional
`$ (anyOf 1).preview_type (anyOf 1)`	string	Alternative
`$ (anyOf 1).preview_type (anyOf 2)`	null	Alternative
`$ (anyOf 1).created_timestamp`	JSON	Optional
`$ (anyOf 1).created_timestamp (anyOf 1)`	string	Alternative
`$ (anyOf 1).created_timestamp (anyOf 2)`	null	Alternative
`$ (anyOf 1).client_modified`	string	Required within parent
`$ (anyOf 1).server_modified`	string	Required within parent
`$ (anyOf 1).rev`	string	Required within parent	Minimum length: 9 Pattern: ^(?:[0-9a-f]+)$
`$ (anyOf 1).size`	JSON	Required within parent
`$ (anyOf 1).size (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 1).size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: folder
`$ (anyOf 2).url`	string	Required within parent
`$ (anyOf 2).id`	JSON	Optional
`$ (anyOf 2).id (anyOf 1)`	string	Alternative	Minimum length: 1
`$ (anyOf 2).id (anyOf 2)`	null	Alternative
`$ (anyOf 2).name`	string	Required within parent
`$ (anyOf 2).expires`	JSON	Optional
`$ (anyOf 2).expires (anyOf 1)`	string	Alternative
`$ (anyOf 2).expires (anyOf 2)`	null	Alternative
`$ (anyOf 2).path_lower`	JSON	Optional
`$ (anyOf 2).path_lower (anyOf 1)`	string	Alternative
`$ (anyOf 2).path_lower (anyOf 2)`	null	Alternative
`$ (anyOf 2).link_permissions`	Model	Required within parent	Expand Get the shared link's metadata — response body — tag file link permissions
`$ (anyOf 2).team_member_info`	JSON	Optional
`$ (anyOf 2).team_member_info (anyOf 1)`	Model	Alternative	Expand Get the shared link's metadata — response body — tag file team member info Information about a team member
`$ (anyOf 2).team_member_info (anyOf 2)`	null	Alternative
`$ (anyOf 2).content_owner_team_info`	JSON	Optional
`$ (anyOf 2).content_owner_team_info (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
`$ (anyOf 2).content_owner_team_info (anyOf 2)`	null	Alternative
`$ (anyOf 2).preview_type`	JSON	Optional
`$ (anyOf 2).preview_type (anyOf 1)`	string	Alternative
`$ (anyOf 2).preview_type (anyOf 2)`	null	Alternative
`$ (anyOf 2).created_timestamp`	JSON	Optional
`$ (anyOf 2).created_timestamp (anyOf 1)`	string	Alternative
`$ (anyOf 2).created_timestamp (anyOf 2)`	null	Alternative
`$ (anyOf 3)`	object	Alternative	The metadata of a shared link.
`$ (anyOf 3).url`	string	Required within parent
`$ (anyOf 3).id`	JSON	Optional
`$ (anyOf 3).id (anyOf 1)`	string	Alternative	Minimum length: 1
`$ (anyOf 3).id (anyOf 2)`	null	Alternative
`$ (anyOf 3).name`	string	Required within parent
`$ (anyOf 3).expires`	JSON	Optional
`$ (anyOf 3).expires (anyOf 1)`	string	Alternative
`$ (anyOf 3).expires (anyOf 2)`	null	Alternative
`$ (anyOf 3).path_lower`	JSON	Optional
`$ (anyOf 3).path_lower (anyOf 1)`	string	Alternative
`$ (anyOf 3).path_lower (anyOf 2)`	null	Alternative
`$ (anyOf 3).link_permissions`	Model	Required within parent	Expand Get the shared link's metadata — response body — tag file link permissions
`$ (anyOf 3).team_member_info`	JSON	Optional
`$ (anyOf 3).team_member_info (anyOf 1)`	Model	Alternative	Expand Get the shared link's metadata — response body — tag file team member info Information about a team member
`$ (anyOf 3).team_member_info (anyOf 2)`	null	Alternative
`$ (anyOf 3).content_owner_team_info`	JSON	Optional
`$ (anyOf 3).content_owner_team_info (anyOf 1)`	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
`$ (anyOf 3).content_owner_team_info (anyOf 2)`	null	Alternative
`$ (anyOf 3).preview_type`	JSON	Optional
`$ (anyOf 3).preview_type (anyOf 1)`	string	Alternative
`$ (anyOf 3).preview_type (anyOf 2)`	null	Alternative
`$ (anyOf 3).created_timestamp`	JSON	Optional
`$ (anyOf 3).created_timestamp (anyOf 1)`	string	Alternative
`$ (anyOf 3).created_timestamp (anyOf 2)`	null	Alternative
`$ (anyOf 3)..tag`	string	Optional	Pattern: ^(?!(?:file\|folder)$)

Referenced models: Get the shared link's metadata — response body — tag file link permissions, Get the shared link's metadata — response body — tag file team member info Information about a team member, Update the viewer info policy of a file — response body — owner team Information about a team

Create a shared link with custom settings — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`path`	string	Required within parent	Pattern: ^(?:(/(.\|[\r\n])\|id:.)\|(rev:[0-9a-f]{9,})\|(ns:[0-9]+(/(.\|[\r\n])*)?))$
`settings`	JSON	Optional
`settings (anyOf 1)`	Model	Alternative	Expand Modify the shared link's settings — request body — body settings
`settings (anyOf 2)`	null	Alternative

Referenced models: Modify the shared link's settings — request body — body settings

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_create_shared_link_with_settings. Catalog operation: sharing/create_shared_link_with_settings. 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