Books

Update a book

Edits a book's details, as the app's edit form does, or hides it from the shelf. Free. Send only the fields to change. Covers generated later use the new details; existing covers do not change. Text fields pass the same moderation as POST /api/v1/books.

patch/api/v1/books/{bookId}

Request

  • Base URL: https://beyourcover.com
  • URL: https://beyourcover.com/api/v1/books/{bookId}
  • Auth: HTTP bearer

Path parameters

bookIdstring uuid required

The book id returned by POST /api/v1/books.

Request body

titlestring
authorstring nullable
subtitlestring nullable
summarystring nullable
genrestring

A genre slug or canonical value, as in POST /api/v1/books. A new genre keeps the stored subgenre only when it belongs to that genre; otherwise the subgenre is cleared.

subgenrestring nullable

One of the genre's subgenres (see GET /api/v1/templates).

target_audiencestring nullable
planner_yearstring nullable
visibility'default' | 'hidden'

hidden takes the book off the shelf; nothing is deleted.

Response

The updated book.

bookIdstring uuid required
titlestring required
authorstring nullable
subtitlestring nullable
genrestring required

Canonical genre value (e.g. Science Fiction).

subgenrestring nullable
summarystring nullable
target_audiencestring nullable
planner_yearstring nullable

Planner & Journal books only: the year on the cover.

visibility'default' | 'hidden' required

hidden books are off the dashboard shelf and out of GET /api/v1/books unless include_hidden=true.

source_type'generated' | 'external_wrap' | 'premade' required

generated = made in the generator or the API; external_wrap = an uploaded cover (External Cover Studio); premade = a bought premade cover.

thumbnail_cover_idstring uuid nullable required

The coverId that represents the book on the shelf: the newest cover marked favorite, else the newest cover. Null when the book has no covers.

covers_countinteger required

Every cover of the book, hidden ones included (the dashboard's "N covers").

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.