Sign in

v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
workbooks

Update a workbook

Updates a workbook <Note> Adding a sheet to a workbook does not require the config object to be provided, however updating an existing sheet does. </Note>

patch/workbooks/{workbookId}

Path parameters

workbookIdstring required

Workbook ID

ID of workbook to update

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

namestring

The name of the Workbook.

labelsstring[]

An optional list of labels for the Workbook.

spaceIdstring

Space ID

environmentIdstring

Environment ID

namespacestring

The namespace of the Workbook.

{"stackTrail":"components:schemas:type_workbooks%3AWorkbookUpdate:properties:metadata","oasType":"schema","type":"unknown","description":"Metadata for the workbook"}
folderstring

The folder to group the workbook in

Response

Response with status 200