Bookmarks

Update a bookmark

Changed on

Partially update a bookmark. Only the fields provided in the request body will be updated. Supports updating common fields (title, note, archived, favourited) as well as type-specific fields.

patch/bookmarks/{bookmarkId}

Request

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

Path parameters

bookmarkIdstring required

The unique identifier of the bookmark.

Example:ieidlxygmwj87oxz5hxttoc8

Request body

archivedboolean
favouritedboolean
summarystring nullable
notestring
titlestring nullable
createdAtstring date-time
urlstring uri
descriptionstring nullable
authorstring nullable
publisherstring nullable
datePublishedstring date-time nullable
dateModifiedstring date-time nullable
textstring nullable
assetContentstring nullable

Response

The updated bookmark.

idstring required
firstCreatedAtstring date-time
createdAtstring date-time required
modifiedAtstring date-time nullable required
titlestring nullable
archivedboolean required
favouritedboolean required
taggingStatus'success' | 'failure' | 'pending' | 'null' nullable required
summarizationStatus'success' | 'failure' | 'pending' | 'null' nullable required
embeddingStatus'success' | 'failure' | 'pending' | 'null' nullable required
notestring nullable
summarystring nullable
source'api' | 'web' | 'cli' | 'mobile' | 'extension' | 'singlefile' | 'rss' | 'import' | 'null' nullable
userIdstring required

Changes