View as Markdown
Box icon

Box ACTION

Create Shared Link

Creates or updates a shared link for a file or folder. Access levels: open, company, or collaborators. A password can only be set when access is open; download permission applies only when access is open or company. A resource can have only one shared link at a time. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run Create Shared Link from your backend or agent.

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Shared Link inputs
Property Type Description
itemType Item Type string
The type of Box item. Valid values: file or folder.
Required
item File or Folder string
The Box file or folder to share. The available items are filtered by Item Type (e.g. 123456789).
Required Dynamic
access Access Level string
The access level for the shared link. If not set, the enterprise default is used. Valid values: open, company, collaborators.
Optional
password Password string
The password required to access the shared link. Can only be set when access is open.
Optional
unsharedAt Unshared At string
The timestamp at which the shared link will expire. Must be in RFC3339 format, e.g. 2022-07-20T10:53:43-08:00
Optional
canDownload Can Download boolean
Whether the shared link allows downloads. Only applicable when access is open or company.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
box-create-shared-link
Version
0.0.2
App
Box
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes