Skip to content

Update a bookmark

PUT
/api/v1/bookmarks/{bookmarkId}
curl --request PUT \
--url http://127.0.0.1:58259/api/v1/bookmarks/1 \
--header 'Content-Type: application/json' \
--data '{ "title": "example", "cfi": "example", "color": "example", "notes": "example", "priority": 1, "pageNumber": 1 }'

Update an existing bookmark’s properties (title, location, color, etc.).

bookmarkId
required
integer format: int64

ID of the bookmark to update

Media type application/json

Bookmark update request

object
title
string
0 <= 255 characters
cfi
string
0 <= 500 characters
color
string
/^#[0-9A-Fa-f]{6}$/
notes
string
0 <= 2000 characters
priority
integer format: int32
>= 1 <= 5
pageNumber
integer format: int32
>= 1
Example generated
{
"title": "example",
"cfi": "example",
"color": "example",
"notes": "example",
"priority": 1,
"pageNumber": 1
}

Bookmark updated 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