43 lines
1.3 KiB
YAML
43 lines
1.3 KiB
YAML
info:
|
|
name: Update Media Highlight
|
|
type: http
|
|
seq: 4
|
|
http:
|
|
method: PUT
|
|
url: '{{base_url}}/api/media-items/{{media_item_id}}/highlights/{{highlight_id}}'
|
|
auth: inherit
|
|
body:
|
|
type: json
|
|
jsonBody: "{\n \"selection_text\": \"This is the updated highlighted text.\"\
|
|
,\n \"start_position\": \"page:45:offset:125\",\n \"end_position\": \"\
|
|
page:45:offset:150\",\n \"color\": \"#ffeb3b\",\n \"note_id\": \"\""
|
|
|
|
docs: |-
|
|
## Update Media Highlight
|
|
|
|
Updates an existing highlight.
|
|
|
|
**Method:** PUT
|
|
|
|
**Endpoint:** /api/media-items/:id/highlights/:highlightId
|
|
|
|
**Path Parameters:**
|
|
- `id` (string): Media item ID
|
|
- `highlightId` (string): Highlight ID
|
|
|
|
**Request Body:**
|
|
- `selection_text` (string): Updated highlighted text (required, 1-5000 chars)
|
|
- `start_position` (string): Updated start position (required, max 100 chars)
|
|
- `end_position` (string): Updated end position (required, max 100 chars)
|
|
- `color` (string): Updated highlight color in hex format (optional)
|
|
- `note_id` (string): Updated associated note ID (optional)
|
|
|
|
**Response:**
|
|
- Updated highlight object with all fields
|
|
|
|
**Status Codes:**
|
|
- 200: Success
|
|
- 400: Invalid request
|
|
- 401: Unauthorized
|
|
- 404: Highlight not found
|