---
title: "Instant JSON schema for efficient PDF bookmarks"
canonical_url: "https://www.nutrient.io/guides/nodejs/json/schema/bookmarks/"
md_url: "https://www.nutrient.io/guides/nodejs/json/schema/bookmarks.md"
last_updated: "2026-05-14T16:53:43.896Z"
description: "Learn to create and manage bookmarks in Instant JSON for improved PDF navigation."
---

# Create and manage PDF bookmarks with Instant JSON

<!-- Common header for Instant JSON Schema articles -->

## Types

This section explains how to use type declarations in Instant JSON records.

The optional keys are specified as follows:

```js

{ optionalKey?: value; }

```

To reduce payload size, omit optional keys when their values are undefined.

## Bookmarks

Bookmarks provide a way to mark [actions](https://www.nutrient.io/guides/nodejs/json/schema/actions.md). Optionally, a bookmark can have a name, in which case clients will show the name of the bookmark.

The data is structured in the following way:

- `v` — The version of the bookmark specification.

- `pdfBookmarkId` — The ID under which the bookmark will be stored in the PDF.

- `type` — The type of the entry. For bookmarks, this will always be "pspdfkit/bookmark".

- `name` — The optional bookmark name. This is used to identify the bookmark.

- `action` — The action that should be triggered when this bookmark is clicked. See [action types](https://www.nutrient.io/guides/nodejs/json/schema/actions.md) for more information about this field.

### JSON

```json

// Example of an Instant JSON schema for a bookmark with a `GoToAction` action:
{
  "action": {
    "pageIndex": 0,
    "type": "goTo"
  },
  "id": "01F46W3SCC92FG68G597N4VHJD",
  "name": "A page bookmark",
  "type": "pspdfkit/bookmark",
  "v": 1
}

```

### JAVASCRIPT

```js

declare type Bookmark = {
  v: 1,
  pdfBookmarkId?: string,
  type: "pspdfkit/bookmark",
  name?: string,
  action: Action
};

```

Refer to the [JSON format schema — actions](https://www.nutrient.io/../actions/) guide for more information about supported action types.
---

## Related pages

- [Understanding Instant JSON attachments and schemas](/guides/nodejs/json/schema/file-attachments.md)
- [Streamline document discussions with Instant Comments](/guides/nodejs/json/schema/comments.md)
- [Understanding Instant JSON action types](/guides/nodejs/json/schema/actions.md)
- [Sync PDF form field values using Instant JSON](/guides/nodejs/json/schema/form-field-values.md)
- [Effective guidelines for PDF form field types](/guides/nodejs/json/schema/form-fields.md)
- [Instant JSON format for PDF annotations explained](/guides/nodejs/json/schema/annotations.md)