# buzz.bookhive.updatePersonalShelf

> Update an existing personal shelf.

- Kind: procedure
- Authority: bookhive.buzz
- Lexicon: 1
- Published by [bookhive.buzz](https://lexicon.garden/identity/did:plc:enu2j5xjlqsjaylv3du4myh4), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.updatePersonalShelf)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.updatePersonalShelf/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.updatePersonalShelf/analytics)

## Procedure (`buzz.bookhive.updatePersonalShelf`)

Type: procedure · POST

### Input (application/json)

- `description` (string): New description for the shelf
  - Constraints: maxLength: 500
- `id` (integer, required): ID of the shelf to update
- `name` (string): New name for the shelf
  - Constraints: minLength: 1, maxLength: 100

### Output (application/json)

- `shelf` (ref, required)
  - Reference: `buzz.bookhive.createPersonalShelf#personalShelfView`

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Update an existing personal shelf.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "description": {
              "description": "New description for the shelf",
              "maxLength": 500,
              "type": "string"
            },
            "id": {
              "description": "ID of the shelf to update",
              "type": "integer"
            },
            "name": {
              "description": "New name for the shelf",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "id"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "shelf": {
              "ref": "buzz.bookhive.createPersonalShelf#personalShelfView",
              "type": "ref"
            }
          },
          "required": [
            "shelf"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "buzz.bookhive.updatePersonalShelf",
  "lexicon": 1
}
```
