Create or update a workbook by slug

put/api/v1/deployments/{deploymentId}/workbooks/by-slug/{slug}

Path parameters

deploymentIdnumber required

slugstring required

Request body

folderIdnumber nullable

metaobject nullable

namestring nullable

Response

calculatedFieldsobject required

createdByinteger

deploymentIdinteger required

folderIdnumber nullable

idinteger required

isFavoriteboolean nullable

metaobject required

namestring required

slugstring nullable

type'FOLDER' | 'WORKBOOK' | 'REPORT' required

userIdnumber nullable

Changes

Changed in 4 of the 10 revisions of this API.136

Aug 30, 20263adb3c5e66ca1See the full diff
- ●
  added the new sankey enum value to the publishedDashboard/oneOf[Dashboard]/reportSnapshots/items/kind/oneOf[ReportSnapshotDtoKind]/ response property for the response status 200
  response-property-enum-value-added
Aug 27, 202697e15146014331See the full diff
- ●
  added the new PARENT enum value to the dashboardDraft/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new PARENT enum value to the dashboardPublished/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new PARENT enum value to the publishedDashboard/oneOf[Dashboard]/config/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property publishedDashboard/oneOf[Dashboard]/reportSnapshots/items/pythonCode to the response with the 200 status
  response-optional-property-added
Aug 17, 202629d481391a2594See the full diff
- ●
  added the new CONTAINER enum value to the dashboardDraft/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new CONTAINER enum value to the dashboardPublished/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new CONTAINER enum value to the publishedDashboard/oneOf[Dashboard]/config/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new DIVIDER enum value to the dashboardDraft/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new DIVIDER enum value to the dashboardPublished/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new DIVIDER enum value to the publishedDashboard/oneOf[Dashboard]/config/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new SPACER enum value to the dashboardDraft/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new SPACER enum value to the dashboardPublished/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new SPACER enum value to the publishedDashboard/oneOf[Dashboard]/config/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property publishedDashboard/oneOf[Dashboard]/reportSnapshots/items/isSourceReport to the response with the 200 status
  response-optional-property-added
- ○
  removed the TABS_CONTAINER enum value from the dashboardDraft/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the TABS_CONTAINER enum value from the dashboardPublished/oneOf[DashboardConfig]/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the TABS_CONTAINER enum value from the publishedDashboard/oneOf[Dashboard]/config/widgets/oneOf[subschema #1]/items/type response property for the response status 200
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 2026a0c6b1d2ac961See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history