View as Markdown
Box icon

Box ACTION

Move Folder

Moves a folder to a new parent folder. Optionally rename the folder while moving. Provide the source folder ID and destination parent folder ID (0 for root). Cannot move a folder into itself or one of its descendants. When renaming, the new name must be 1-255 characters, use only Unicode Basic Multilingual Plane (BMP) characters, and cannot contain non-printable characters, / or \, leading or trailing spaces, or be . or ... Use Create Folder to create a destination first if needed. See folder name restrictions. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run Move 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-move-folder",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    box: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Folder",
    destinationFolderId: "Destination Folder",
  },
})

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.

Move Folder inputs
Property Type Description
folderId Folder string
The folder to move (e.g. 123456789). Use the List Folders action to retrieve folder IDs.
Required Dynamic
destinationFolderId Destination Folder string
The destination parent folder. Use 0 for the root folder. Use the List Folders action to retrieve folder IDs.
Required Dynamic
name New Name string
Optionally rename the folder while moving. Must be 1-255 characters and use only Unicode Basic Multilingual Plane (BMP) characters. Cannot contain non-printable characters, / or \, leading or trailing spaces, or be . or ... See folder name restrictions.
Optional
fields Fields string[]
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response, e.g. id,type,name
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-move-folder
Version
0.0.2
App
Box
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes