Skip to navigation
Sigma REST APIWorkbooksbookmarks

Update a saved view in a tagged workbook

View as Markdown

Update a saved view (formerly called a bookmark) in a version-tagged workbook, for example by associating it with a newer custom view.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • Retrieve the tagName by calling the /v2/tags endpoint and using the name in the response.
  • Retrieve the bookmarkId by calling the /v2/workbooks/{workbookId}/tags/{tagName}/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 tagged workbook opens.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.
tagNamestringRequired
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.