Update a workbook

PUT /v1/deployments/{deploymentId}/workbooks/{workbookId}

Update a workbook

cURL

curl --request PUT \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folderId": 123,
  "meta": {},
  "name": "<string>"
}
'

Update a workbook’s properties. All fields are optional; only the fields you send are changed.

• name — rename the workbook.
• meta — replace the workbook’s metadata object.
• folderId — move the workbook between folders. Set it to a folder id to move the workbook into that folder, or to null to move it back to the workspace root.

Access depends on what you change. Renaming or editing metadata requires edit access to the workbook. Moving the workbook (any request that includes folderId) requires manage access to the workbook, plus edit access to the destination folder when moving into one.

To move a workbook you can use either this endpoint or the unified POST /workspace/move. Returns 404 if the workbook 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

workbookId · number · required

Body

application/json

UpdateWorkbookInput

folderId · number | null

meta · object

name · string | null

Response

200 - application/json

Successful response