Sign in
Highlights

Update a highlight

Changed on

Partially update a highlight. Supports changing the color or note.

patch/highlights/{highlightId}

Request

  • Base URL: https://try.karakeep.app/api/v1
  • URL: https://try.karakeep.app/api/v1/highlights/{highlightId}
  • Auth: HTTP bearer

Path parameters

highlightIdstring required

The unique identifier of the highlight.

Example:ieidlxygmwj87oxz5hxttoc8

Request body

color'yellow' | 'red' | 'green' | 'blue'
notestring nullable

Response

The updated highlight.

bookmarkIdstring required
startOffsetnumber required
endOffsetnumber required
color'yellow' | 'red' | 'green' | 'blue'
textstring nullable required
notestring nullable required
idstring required
userIdstring required
createdAtstring date-time required

Changes