API ReferenceNotebook

Update Metadata

Updates metadata about a workbook, but not its contents.

Path parameters

ridstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
titlestringOptional
dataScopeobjectOptional

Optional for backcompatibility.

descriptionstringOptional
propertiesmap from strings to stringsOptional
labelsset of stringsOptional
isDraftbooleanOptional

Response

This endpoint returns an object.
dataScopeobject
notebookTypeenum
Allowed values:
titlestring
descriptionstring
isDraftboolean
isArchivedboolean
lockobject
createdByRidstring
createdAtdatetime
propertiesmap from strings to strings
labelsset of strings
runRidstringOptional

deprecated. Use dataScope instead