Skip to content

Create a note

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

Create a new note at a specific location in a book.

Media type application/json

Note creation request

object
bookId
required
integer format: int64
cfi
required
string
0 <= 1000 characters
selectedText
string
0 <= 5000 characters
noteContent
required
string
>= 1 characters
color
string
/^#[0-9A-Fa-f]{6}$/
chapterTitle
string
0 <= 500 characters
Example generated
{
"bookId": 1,
"cfi": "example",
"selectedText": "example",
"noteContent": "example",
"color": "example",
"chapterTitle": "example"
}

Note created 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