Update a workbook bookmark

PATCH

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

Update a workbook bookmark, for example by updating the bookmark to use a new exploration of the workbook.

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 workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: :explore=76c76e52-8d94-448a-969c-32cc18da9ea0. Provide the ID after the =.

Update a workbook bookmark, for example by updating the bookmark to use a new exploration of the workbook. ### 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 workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

bookmarkIdstringRequired

Request

The request body.

namestring or nullOptional

isSharedboolean or nullOptional

isDefaultboolean or nullOptional

exploreKeystring or nullOptional

ID of the associated exploration.

Response

The response body.

bookmarkIdstring

namestring

isSharedboolean

Whether the bookmark is shared.

exploreKeystring

ID of the associated exploration.

isDefaultboolean

Whether the bookmark is default.

$	curl -X PATCH https://api.sigmacomputing.com/v2/workbooks/workbookId/bookmarks/bookmarkId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"bookmarkId": "bkmk-9f8e7d6c5b4a3e2f1d0c",
3	"name": "Q2 Sales Analysis",
4	"isShared": true,
5	"exploreKey": "76c76e52-8d94-448a-969c-32cc18da9ea0",
6	"isDefault": false
7	}