# ink.branchline.bookmark

> Published by [branchline.ink](https://lexicon.garden/identity/did:plc:brvu7akhdvsqcomb67pafw25)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.bookmark)
- [Documentation](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.bookmark/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.bookmark/examples)

## Definitions

### `ink.branchline.bookmark`

**Type**: `record`

A bookmark the authoring account placed on a bud — a private-intent save pointing at a specific bud in a story. The AppView collapses bookmarks on the same ancestor chain into a single record: re-bookmarking a bud that is an ancestor or descendant of an existing bookmark rewrites the existing record's subject via putRecord rather than creating a second one. Navigation resolves the bookmark to the furthest-read bud on the path containing the subject, falling back to the subject itself.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `subject` | `ref` → `com.atproto.repo.strongRef` | Yes | Strong ref to the ink.branchline.bud record being bookmarked. |
| `createdAt` | `string` (datetime) | Yes |  |

## Raw Schema

```json
{
  "id": "ink.branchline.bookmark",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "subject",
          "createdAt"
        ],
        "properties": {
          "subject": {
            "ref": "com.atproto.repo.strongRef",
            "type": "ref",
            "description": "Strong ref to the ink.branchline.bud record being bookmarked."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          }
        }
      },
      "description": "A bookmark the authoring account placed on a bud — a private-intent save pointing at a specific bud in a story. The AppView collapses bookmarks on the same ancestor chain into a single record: re-bookmarking a bud that is an ancestor or descendant of an existing bookmark rewrites the existing record's subject via putRecord rather than creating a second one. Navigation resolves the bookmark to the furthest-read bud on the path containing the subject, falling back to the subject itself."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
