Files
bookhoard/docs/developer/api/highlights/update_highlight.md
T
John O'Keefe 7a7b2ab82a docs(highlights,notes,opds,progress,analytics): Beam batch 9 — 13 endpoints
Highlights + notes CRUD (media-item scoped, jwt), progress delete,
reading-stats analytics, and the OPDS trio frontmatter'd. OPDS docs are
the first XML entries: example-response intentionally omitted (Atom
responses), gate contract honored via nil-Response registry pins.

Gate fix: group .Use() middleware now parsed (opds.Use(DeviceAuth...
Authenticate) previously resolved to auth 'none'). Registry: 13 entries.
Drift fixed by gate: reading-stats key names (total_reading_time_minutes,
most_active_day_of_week, daily_reading_minutes — draft invented
reading_time_hours/books_completed); notes/highlights list endpoints
return BARE arrays (no {notes:[]}/{highlights:[]} wrapper); create-note
request has no percentage_location/epubcfi_location. New
/tmp/merge_arrays.py handles array-example merges.

make test 9/9.
2026-10-24 17:47:07 -04:00

81 lines
1.9 KiB
Markdown

---
method: PUT
path: /api/media-items/:id/highlights/:highlightId
auth: jwt
area: media-items
---
<!-- source: internal/handlers/media.go:2097 MediaHandler.UpdateMediaHighlight -->
# Update Highlight
Update an existing highlight.
**Endpoint**: `PUT /api/media-items/:id/highlights/:highlightId`
**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
```json example-request
{
"selection_text": "Updated text",
"color": "#00ff00"
}
```
## Response (200 OK)
```json example-response
{
"id": "uuid",
"media_item_id": "uuid",
"user_id": "uuid",
"selection_text": "Updated text",
"color": "#00ff00",
"updated_at": "2026-01-31T10:00:00Z",
"chapter_reference": null,
"character_end": null,
"character_start": null,
"created_at": null,
"dedup_key": null,
"deleted": null,
"deleted_at": null,
"device_sync_data": null,
"end_position": null,
"epubcfi_end": null,
"epubcfi_start": null,
"last_modified_at": null,
"last_modified_source": null,
"note_id": null,
"note_text": null,
"panel_number": null,
"paragraph_end": null,
"paragraph_start": null,
"percentage_end": null,
"percentage_start": null,
"start_position": null
}
```
## Error Responses
| Code | Description |
| ---- | -------------------------------- |
| 400 | Invalid highlight data |
| 401 | Invalid or expired token |
| 403 | User does not own this highlight |
| 404 | Highlight not found |