Covers

Hide or favorite a cover

Sets a cover's visibility, as the eye and heart buttons do in the app. Free. favorite makes the cover represent its book on the shelf (the newest favorite wins); hidden takes it out of GET /api/v1/books/{bookId}/covers and the app's book view (nothing is deleted); default undoes either.

patch/api/v1/covers/{coverId}

Request

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

Path parameters

coverIdstring uuid required

The cover's public id (UUID) as returned in job results (covers[].coverId).

Request body

visibility'default' | 'favorite' | 'hidden' required

Response

The new visibility.

coverIdstring uuid required
bookIdstring uuid required
visibility'default' | 'favorite' | 'hidden' required

Changes

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