DELETE
/
v1
/
teams
/
{teamId}
/
folders
/
{folderId}
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.folders.removeFolder({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  folderId: process.env.OCTOSPARK_FOLDER_ID ?? "folderId",
  query: {
    "mode": process.env.OCTOSPARK_MODE ?? "mode",
  },
})
{
  "mode": "delete_contents",
  "deletedAssetCount": 123,
  "deletedFolderCount": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

folderId
string
required

Media-library folder id (UUID), as returned by the list folders endpoint.

Query Parameters

mode
enum<string>
required

What happens to the folder contents: delete_contents soft-deletes every asset and subfolder, move_to_parent reparents them before removing the folder.

Available options:
delete_contents,
move_to_parent
Example:

"move_to_parent"

Response

Success

mode
enum<string>
required
Available options:
delete_contents
deletedAssetCount
number
required
deletedFolderCount
number
required