Create Shared Link
box.create_shared_link
ActionFiles & storageconnection required
Calls the Box API with the connection's credentials.
Add or update the shared link on a file or folder and return the URL people can open.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Box
- Secret shape
- {"client_id": "…", "client_secret": "…", "box_subject_type": "enterprise|user", "box_subject_id": "…"} for a server-authentication app, or {"client_id": "…", "client_secret": "…", "refresh_token": "…"} for OAuth2
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
item_type Whether the item is a file or a folder — Box uses a different path for each. | string | No | file | one of "file", "folder" | — |
item_id The id of the file or folder to act on. | string | Yes | — | — | — |
access Who may open the link. Leave blank to use the enterprise default. | string | No | — | one of "open", "company", "collaborators" | — |
password A password the visitor must enter. Box only allows one when access is 'open'. | string | No | — | credential material | credential |
unshared_at When the link should stop working, as an RFC 3339 timestamp. Paid accounts only. | string | No | — | iso8601 format | — |
can_download Whether visitors may download the item. Box only allows this when access is 'open' or 'company'. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"item_type": "file"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The id of the shared item. | string | — |
type Whether the shared item is a file or a folder. | string | — |
url The shared link people can open. | string | — |
download_url The direct-download link, when downloads are allowed. | string | — |
access The access level Box applied. | string | — |
shared_link The full shared_link object Box returned. | object | — |
{
"access": "",
"download_url": "",
"id": "",
"shared_link": {},
"type": "",
"url": ""
}Notes
- Uploads go to upload.box.com and everything else to api.box.com; the nodes pick the right host for you.
- Use a Box server-authentication (Client Credentials) app for anything unattended: its credential can be exchanged for a token indefinitely. A plain OAuth2 refresh token is spent by its first use, so that connection needs re-authorising.
- The root folder always has the id '0'.
See Create Shared Link run in a workflow.
In a technical demo we add the Box connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.