Workbooks

Update a saved view

Update a saved view (formerly called a bookmark), for example by associating it with a newer custom view.

Retrieve the workbookId by calling the /v2/workbooks endpoint.
Retrieve the bookmarkId by calling the /v2/workbooks/{workbookId}/bookmarks endpoint.
Retrieve the exploreKey by identifying the ID of the custom view that you want to save. When viewing a custom view in a workbook, its explore key is visible in the URL: :explore=76c76e52-8d94-448a-969c-32cc18da9ea0. Provide the ID after the =.

Rename or share: Update the saved view name or change whether it is shared.
Refresh from a custom view: Associate the saved view with a newer custom view by sending a new exploreKey.
Set a default view: Set isDefault to make this saved view the default when the workbook opens.

patch/v2/workbooks/{workbookId}/bookmarks/{bookmarkId}

Request

workbookIdstring required

Unique identifier of the workbook.

bookmarkIdstring required

Unique identifier of the saved view (formerly called a bookmark).

namestring nullable

isSharedboolean nullable

isDefaultboolean nullable

exploreKeystring nullable

ID of the associated custom view.

The response body.

bookmarkIdstring required

namestring required

isSharedboolean required

Whether the saved view is shared.

exploreKeystring required

ID of the associated custom view.

isDefaultboolean

Whether this saved view is the default view for the workbook.

No recorded changes to this operation across all 1 revision of this API.