Skip to content

Update viewer settings

PUT
/api/v1/books/{bookId}/viewer-setting
curl --request PUT \
--url http://127.0.0.1:58259/api/v1/books/1/viewer-setting \
--header 'Content-Type: application/json' \
--data '{ "pdfSettings": { "bookId": 1, "zoom": "example", "spread": "example", "isDarkTheme": true }, "newPdfSettings": { "bookId": 1, "pageSpread": "EVEN", "pageViewMode": "SINGLE_PAGE", "backgroundColor": "GRAY", "fitMode": "ACTUAL_SIZE", "scrollMode": "PAGINATED" }, "ebookSettings": { "bookId": 1, "userId": 1, "fontFamily": "example", "fontSize": 1, "gap": 1, "hyphenate": true, "isDark": true, "justify": true, "lineHeight": 1, "maxBlockSize": 1, "maxColumnCount": 1, "maxInlineSize": 1, "theme": "example", "flow": "example" }, "cbxSettings": { "bookId": 1, "pageSpread": "EVEN", "pageViewMode": "SINGLE_PAGE", "fitMode": "ACTUAL_SIZE", "scrollMode": "PAGINATED", "backgroundColor": "GRAY" } }'

Update viewer settings for a specific book.

bookId
required
integer format: int64

ID of the book

Media type application/json

Viewer settings to update

object
pdfSettings
object
bookId
integer format: int64
zoom
string
spread
string
isDarkTheme
boolean
newPdfSettings
object
bookId
integer format: int64
pageSpread
string
Allowed values: EVEN ODD
pageViewMode
string
Allowed values: SINGLE_PAGE TWO_PAGE
backgroundColor
string
Allowed values: GRAY BLACK WHITE
fitMode
string
Allowed values: ACTUAL_SIZE FIT_PAGE FIT_WIDTH FIT_HEIGHT AUTO
scrollMode
string
Allowed values: PAGINATED INFINITE
ebookSettings
object
bookId
integer format: int64
userId
integer format: int64
fontFamily
string
fontSize
integer format: int32
gap
number format: float
hyphenate
boolean
isDark
boolean
justify
boolean
lineHeight
number format: float
maxBlockSize
integer format: int32
maxColumnCount
integer format: int32
maxInlineSize
integer format: int32
theme
string
flow
string
cbxSettings
object
bookId
integer format: int64
pageSpread
string
Allowed values: EVEN ODD
pageViewMode
string
Allowed values: SINGLE_PAGE TWO_PAGE
fitMode
string
Allowed values: ACTUAL_SIZE FIT_PAGE FIT_WIDTH FIT_HEIGHT AUTO
scrollMode
string
Allowed values: PAGINATED INFINITE LONG_STRIP
backgroundColor
string
Allowed values: GRAY BLACK WHITE

Viewer settings updated successfully