Skip to content

Update a shelf

PUT
/api/v1/shelves/{shelfId}
curl --request PUT \
--url http://127.0.0.1:58259/api/v1/shelves/1 \
--header 'Content-Type: application/json' \
--data '{ "id": 1, "name": "example", "icon": "example", "iconType": "PRIME_NG", "publicShelf": true }'

Update an existing shelf by its ID.

shelfId
required
integer format: int64

ID of the shelf

Media type application/json

Shelf creation request

object
id
integer format: int64
name
required
string
>= 1 characters
icon
string
iconType
string
Allowed values: PRIME_NG CUSTOM_SVG
publicShelf
boolean

Shelf updated successfully

Media type */*
object
id
integer format: int64
name
string
icon
string
iconType
string
Allowed values: PRIME_NG CUSTOM_SVG
sort
object
field
string
direction
string
Allowed values: ASCENDING DESCENDING
userId
integer format: int64
publicShelf
boolean
bookCount
integer format: int32