View as Markdown
Box icon

Box ACTION

Delete Folder

Deletes a folder by moving it to trash (or permanently when enterprise settings require). Set Recursive to true to delete non-empty folders and all contents; without it, deleting a non-empty folder fails. Deleting a large folder can take longer than Box's request timeout — Box then returns HTTP 503 while the deletion continues in the background, which this action reports as accepted (accepted: true). This cannot be undone from this action — use List Folder Items to verify contents first. See the documentation.
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run Delete Folder from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "box-delete-folder",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    box: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Folder",
    recursive: true,
  },
})

console.log(result)

SCHEMA

Inputs

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

Delete Folder inputs
Property Type Description
folderId Folder string
The folder to delete (e.g. 123456789). Cannot delete the root folder (0). Use the List Folders action to retrieve folder IDs.
Required Dynamic
recursive Recursive boolean
Delete a folder that is not empty by recursively deleting the folder and its contents
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-delete-folder
Version
0.0.2
App
Box
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes