Files
bookhoard/docs/api/highlights/update_highlight.md
T
john-okeefe 284486f0a0 docs: add progress, notes, and highlights API endpoints
Phase 2 part 4: Split reading progress and annotation endpoints
- Progress: get_progress, update_progress, delete_progress
- Notes: get_notes, create_note, update_note, delete_note
- Highlights: get_highlights, create_highlight, update_highlight, delete_highlight
- All endpoints support EPUB CFI and percentage locations
2026-02-02 08:51:48 -05:00

1.1 KiB

Update Highlight

Update an existing highlight.

Endpoint: PUT /api/media-items/highlights/{highlight_id} Auth: Required Content-Type: application/json

Path Parameters

Parameter Type Required Description
highlight_id string Yes Highlight UUID

Request Body

Field Type Required Description
selection_text string No Updated highlighted text
color string No Updated highlight color (hex)

Example Request

{
  "selection_text": "Updated text",
  "color": "#00ff00"
}

Response (200 OK)

{
  "id": "uuid",
  "media_item_id": "uuid",
  "user_id": "uuid",
  "selection_text": "Updated text",
  "color": "#00ff00",
  "updated_at": "2026-01-31T10:00:00Z"
}

Error Responses

Code Description
400 Invalid highlight data
401 Invalid or expired token
403 User does not own this highlight
404 Highlight not found

Try It Out