Skip to main content
POST
Move a workspace item
Move any workspace item — a workbook, report, or folder — into a folder, in one unified endpoint. Returns the moved item. Request body:
  • type — the item type: WORKBOOK, REPORT, or FOLDER.
  • id — the id of the item to move.
  • folderId — the destination folder id, or null to move the item to the workspace root. For a folder, this becomes its new parent.
Access requirements depend on the item type and mirror the per-type rules:
  • Workbook — manage access to the workbook, plus edit access to the destination folder when moving into one.
  • Report — edit access to the report (with the report-manage permission).
  • Folder — manage access to the folder being moved, plus manage or edit access to the destination parent folder.
Moving a folder into one of its own descendants, or exceeding the maximum folder depth, is rejected with 400. Returns 404 if the item does not exist or belongs to a different deployment.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required

Body

application/json

MoveWorkspaceObjectInput

id
integer
required
type
enum<string>
required
Available options:
FOLDER,
WORKBOOK,
REPORT
folderId
integer | null

Response

200 - application/json
calculatedFields
object
required
createdAt
required
deploymentId
integer
required
id
integer
required
meta
object
required
name
string
required
type
enum<string>
required
Available options:
FOLDER,
WORKBOOK,
REPORT
updatedAt
required
createdBy
integer
dashboardDraft
object | null
dashboardPublished
object | null
folderId
number | null
isFavorite
boolean | null
publishedDashboard
object | null
slug
string | null
user
object | null
userId
number | null