---
title: "Hide or favorite a cover"
method: PATCH
path: "/api/v1/covers/{coverId}"
tags: ["Covers"]
---

# Hide or favorite a cover

`PATCH /api/v1/covers/{coverId}`

## Request

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

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.

## Path parameters

- `coverId` string, uuid, required

## Request body

- object
  - `visibility` 'default' | 'favorite' | 'hidden', required

## Response `200`

The new visibility.

- object
  - `coverId` string, uuid, required
  - `bookId` string, uuid, required
  - `visibility` 'default' | 'favorite' | 'hidden', required

## Other responses

- `400`: `code` is `invalid_visibility`.
- `401`: Missing/malformed API key, unknown or inactive key, or inactive subscription detected during credit checks. `code`: `unauthorized`.
- `403`: The API key is valid but its owner has no active enterprise subscription. `code`: `forbidden`.
- `404`: `code` is `cover_not_found`.
- `500`: Server error. `code` is `cover_update_failed` or `internal_error`.

---

[API](https://skmtc.dev/beyourcover/apis/beyourcover-partner-api.md) · [All operations](https://skmtc.dev/beyourcover/apis/beyourcover-partner-api/llms.txt) · [OpenAPI document](https://skmtc.dev/beyourcover/apis/beyourcover-partner-api/revisions/82ad2c7c8ede?raw)
