Skip to content

Create a bookmark

POST
/api/v1/bookmarks
curl --request POST \
--url http://127.0.0.1:58259/api/v1/bookmarks \
--header 'Content-Type: application/json' \
--data '{ "bookId": 1, "cfi": "example", "positionMs": 1, "trackIndex": 1, "pageNumber": 1, "title": "example", "audiobookBookmark": true, "pdfBookmark": true }'

Create a new bookmark for a book.

Media type application/json

Bookmark creation request

object
bookId
required
integer format: int64
cfi
string
positionMs
integer format: int64
trackIndex
integer format: int32
pageNumber
integer format: int32
>= 1
title
string
audiobookBookmark
boolean
pdfBookmark
boolean
Example generated
{
"bookId": 1,
"cfi": "example",
"positionMs": 1,
"trackIndex": 1,
"pageNumber": 1,
"title": "example",
"audiobookBookmark": true,
"pdfBookmark": true
}

Bookmark created successfully

Media type */*
object
id
integer format: int64
userId
integer format: int64
bookId
integer format: int64
cfi
string
positionMs
integer format: int64
trackIndex
integer format: int32
pageNumber
integer format: int32
title
string
color
string
notes
string
priority
integer format: int32
createdAt
string format: date-time
updatedAt
string format: date-time