Skip to content

Update a note

PUT
/api/v2/book-notes/{noteId}
curl --request PUT \
--url http://127.0.0.1:58259/api/v2/book-notes/1 \
--header 'Content-Type: application/json' \
--data '{ "noteContent": "example", "color": "example", "chapterTitle": "example" }'

Update an existing note’s content or color.

noteId
required
integer format: int64

ID of the note to update

Media type application/json

Note update request

object
noteContent
string
color
string
/^#[0-9A-Fa-f]{6}$/
chapterTitle
string
0 <= 500 characters
Example generated
{
"noteContent": "example",
"color": "example",
"chapterTitle": "example"
}

Note updated successfully

Media type */*
object
id
integer format: int64
userId
integer format: int64
bookId
integer format: int64
cfi
string
selectedText
string
noteContent
string
color
string
chapterTitle
string
createdAt
string format: date-time
updatedAt
string format: date-time