Update a saved view

PATCH

/v2/workbooks/:workbookId/bookmarks/:bookmarkId

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

Usage notes

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 =.

Usage scenarios

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.

Update a saved view (formerly called a bookmark), for example by associating it with a newer custom view. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-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 `=`. ### Usage scenarios - **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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Unique identifier of the workbook.

bookmarkIdstringRequired

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

Request

The request body.

namestring or nullOptional

isSharedboolean or nullOptional

isDefaultboolean or nullOptional

exploreKeystring or nullOptional

ID of the associated custom view.

Response

The response body.

bookmarkIdstring

namestring

isSharedboolean

Whether the saved view is shared.

exploreKeystring

ID of the associated custom view.

isDefaultbooleanOptional

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