Add a bookmark to a workbook

POST

/v2/workbooks/:workbookId/bookmarks

Add a bookmark to a workbook.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.
Retrieve the workbookVersion by calling the /v2/workbooks endpoint and using the latestVersion in the response for the workbook, or from the version history More menu for the specific version.
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 =.

Add a bookmark to a workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version. - 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

Request

The request body.

workbookVersiondoubleRequired

namestringRequired

isSharedbooleanRequired

Whether the bookmark is shared.

exploreKeystringRequired

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 POST https://api.sigmacomputing.com/v2/workbooks/workbookId/bookmarks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"workbookVersion": 3.4,
>	"name": "Quarterly Sales Overview",
>	"isShared": true,
>	"exploreKey": "76c76e52-8d94-448a-969c-32cc18da9ea0"
>	}'

1	{
2	"bookmarkId": "b3f1c9a2-5d4e-4f7a-9c2e-1a2b3c4d5e6f",
3	"name": "Quarterly Sales Overview",
4	"isShared": true,
5	"exploreKey": "76c76e52-8d94-448a-969c-32cc18da9ea0",
6	"isDefault": false
7	}