Skip to main content
POST
Delete workspace items in bulk
Delete up to 100 workspace items — workbooks, reports, and folders, mixed freely — in a single request. Request body:
  • items — the items to delete, each { type, id } with type one of WORKBOOK, REPORT, FOLDER. Repeated references to the same item are collapsed, so the response holds exactly one entry per distinct item requested.
This endpoint is partially successful. It returns 200 whenever the request itself is well formed, and reports each item’s outcome separately:
  • deleted — the (type, id) of each item that was deleted.
  • failed — the items that were not deleted, each with the (type, id) requested and an error carrying the status and message the per-type delete endpoint would have returned for it (403 when the caller lacks access, 404 when the item does not exist or belongs to another deployment, 400 when a folder still has sub-folders).
An empty failed array means the whole batch applied. Items are deleted one at a time in the order given, each in its own transaction, so deletions are not rolled back when a later item fails — the response is the record of what was applied. Deleting a folder does not delete the workbooks, dashboards, and reports directly inside it: they are detached and returned to the workspace root, matching DELETE /folders/:folderId. Access is checked per item with the same rules as the per-type delete endpoints: manage access for a workbook or folder, and edit access plus the report-manage permission for a report.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required

Body

application/json

BulkDeleteWorkspaceObjectsInput

items
object[]
required
Required array length: 1 - 100 elements

Response

200 - application/json
deleted
object[]
required
failed
object[]
required