---
title: "Add a saved view to a workbook"
method: POST
path: "/v2/workbooks/{workbookId}/bookmarks"
tags: ["Workbooks"]
---

# Add a saved view to a workbook

`POST /v2/workbooks/{workbookId}/bookmarks`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/workbooks/{workbookId}/bookmarks`
- Auth: HTTP bearer

Add a saved view (formerly called a bookmark) to a workbook. A saved view is a named custom view you can return to later or share.

### 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 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
- **Save a custom view:** Persist filters, controls, or layout changes so you can reopen the same named view later.
- **Share a view:** Set `isShared` to `true` to make the saved view available to other members who can access the workbook.

## Path parameters

- `workbookId` string, required

## Request body

- object
  - `workbookVersion` number, double, required
  - `name` string, required
  - `isShared` boolean, required: Whether the saved view is shared.
  - `exploreKey` string, required: ID of the associated custom view.

## Response `200`

The response body.

- WorkbooksPostWorkbookBookmarksResponse200
  - `bookmarkId` string, required
  - `name` string, required
  - `isShared` boolean, required: Whether the saved view is shared.
  - `exploreKey` string, required: ID of the associated custom view.
  - `isDefault` boolean: Whether this saved view is the default view for the workbook.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)