Delete File
box.delete_file
ActionFiles & storageconnection required
Calls the Box API with the connection's credentials.
Move a file to the Box trash, from where it can still be restored until the trash retention period expires.
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
1 field, 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 |
|---|---|---|---|---|---|
file_id The id of the file to trash. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deleted True when Box accepted the delete. | boolean | — |
id The id of the file that was trashed. | string | — |
type Always 'file'. | string | file |
{
"deleted": false,
"id": "",
"type": "file"
}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 Delete File 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.