Remove Shared Link

box.remove_shared_link
ActionFiles & storageconnection required

Calls the Box API with the connection's credentials.

Remove the shared link from a file or folder so the existing URL stops working.

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

2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
item_type
Whether the item is a file or a folder — Box uses a different path for each.
stringNofileone of "file", "folder"—
item_id
The id of the file or folder to act on.
stringYes———

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "item_type": "file"
}

Output

One shape.

result

FieldTypeExample
id
The id of the item the link was removed from.
string—
type
Whether the item is a file or a folder.
string—
removed
True when Box reports no shared link left.
boolean—
{
  "id": "",
  "removed": false,
  "type": ""
}

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 Remove 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.