# buzz.bookhive.addToList

> Published by [bookhive.buzz](https://lexicon.garden/identity/did:plc:enu2j5xjlqsjaylv3du4myh4)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.addToList)
- [Documentation](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.addToList/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.addToList/examples)

## Definitions

### `buzz.bookhive.addToList`

**Type**: `procedure`

Add a book to a list.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `hiveId` | `string` | Yes | Hive ID of the book to add |
| `listUri` | `string` | Yes | AT-URI of the list |
| `position` | `integer` | No | Position in the list (for ordered lists) |
| `description` | `string` | No | Optional note about this book in the list |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` | Yes |  |
| `uri` | `string` | Yes |  |

## Raw Schema

```json
{
  "id": "buzz.bookhive.addToList",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "listUri",
            "hiveId"
          ],
          "properties": {
            "hiveId": {
              "type": "string",
              "description": "Hive ID of the book to add"
            },
            "listUri": {
              "type": "string",
              "description": "AT-URI of the list"
            },
            "position": {
              "type": "integer",
              "description": "Position in the list (for ordered lists)"
            },
            "description": {
              "type": "string",
              "maxLength": 5000,
              "description": "Optional note about this book in the list"
            }
          }
        },
        "encoding": "application/json"
      },
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "uri",
            "cid"
          ],
          "properties": {
            "cid": {
              "type": "string"
            },
            "uri": {
              "type": "string"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Add a book to a list."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```