Files
bookhoard/docs/developer/api/notes/update_note.md
T
John O'Keefe 50282895f5 fix(docs): Work Order 2 — correct stale paths (11 docs + 3 Bruno)
Fix all wrong-path artifacts identified by the audit:
- Kobo sync endpoints (init/bookmark/markup/sync-from-server/analytics): add
  missing :token device segment (6 doc files incl. kobo-protocol.md)
- Highlights/notes update+delete: add missing /:id media-item prefix
- media-items/download_media_item.md: removed (static /uploads route, not an
  API endpoint; info about the file route is recoverable from OPDS docs)
- Bruno: /libraries/visible -> /visibility, /collections/books missing id,
  /audio/0 -> track_index
- operations/troubleshooting.md: same /libraries/visible -> /visibility fix
- media-items/get_audio_track.md + get_audio_chapters.md: /audio/0 examples fixed
- Deleted monolithic docs/developer/api-reference.md (duplicate of split docs)
- Fixed 4 stale entries in docs/developer/api/api-reference.md (split index)

Audit re-run: orphan docs 0, orphan Bruno 6 (all scenario files with literal IDs).
2026-10-24 14:44:19 -04:00

52 lines
1.1 KiB
Markdown

# Update Note
Update an existing note.
**Endpoint**: `PUT /api/media-items/:id/notes/:noteId`
**Auth**: Required
**Content-Type**: `application/json`
## Path Parameters
| Parameter | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
| note_id | string | Yes | Note UUID |
## Request Body
| Field | Type | Required | Description |
| -------- | ------ | -------- | -------------------------- |
| content | string | No | Updated note content |
| position | string | No | Updated location reference |
### Example Request
```json
{
"content": "Updated note content",
"position": "epubcfi(/6/4/2:20)"
}
```
## Response (200 OK)
```json
{
"id": "uuid",
"media_item_id": "uuid",
"user_id": "uuid",
"content": "Updated note content",
"position": "epubcfi(/6/4/2:20)",
"updated_at": "2026-01-31T10:00:00Z"
}
```
## Error Responses
| Code | Description |
| ---- | --------------------------- |
| 400 | Invalid note data |
| 401 | Invalid or expired token |
| 403 | User does not own this note |
| 404 | Note not found |