# ZoomHub API reference: Viewers

Part of the [ZoomHub API reference](https://zoomhub.net/docs/api.md), whose index covers authentication, errors and the other resources.

> **Beta:** The v2 API is in beta: endpoints, attributes and error codes may still change before it is final. Questions or feedback: [daniel@zoomhub.net](mailto:daniel@zoomhub.net).

Base URL: `https://api.zoomhub.net`. Send your API key as `Authorization: Bearer <key>`; see [Authentication](https://zoomhub.net/docs/api.md#authentication).

## Viewers

A viewer is a saved, configured embed: a gallery that shows a [collection](https://zoomhub.net/docs/api/collections.md#collections), or an image viewer that shows one image. Its `links` give a page to share, an `<iframe>` URL and a `<script>` URL to embed. Change a viewer’s options and every embed of it follows.

A viewer belongs to the owner of what it shows, and can only ever show that owner’s collections and images. Its type is fixed when it is created.

### The viewer object

A saved embed of a collection or an image, with its options.

**Attributes**

- `object` (string): Always `viewer`.
- `id` (string): The viewer’s ID.
- `type` (enum): What the viewer shows, which is also the key its options are under.
  - `gallery`: Shows a collection.
  - `image`: Shows one image.
- `title` (string, nullable): The viewer’s title, or `null`.
- `gallery` (object, optional): Present when `type` is `gallery`: the collection it shows and how.
  - `collection_id` (string): The collection the gallery shows. It must belong to the viewer’s owner.
  - `layout` (enum): How the gallery lays out its images. Every layout keeps the collection’s order.
    - `justified`: Rows of equal height, filled edge to edge.
    - `grid`: Equal cells.
    - `strip`: One row to scroll through.
  - `background` (string): The gallery’s backdrop: `black`, `white`, or a hex color such as `#1c1c1f`.
  - `captions` (enum): Whether each image’s title shows beneath it.
    - `shown`
    - `hidden`
  - `controls` (enum): Which controls the gallery shows.
    - `full`: Every control, including the layout toggle.
    - `minimal`: Only the essential controls.
    - `fixed-layout`: Every control but the layout toggle: opening an image frames it closely, and going home steps back to the wall.
  - `navigation` (enum): How visitors move between images.
    - `arrows`: Previous and next arrows.
    - `numbers`: A ribbon of numbered pills on top, one per image.
  - `arrows` (enum): Where the previous and next arrows sit.
    - `controls`: With the other controls.
    - `sides`: As large buttons on the gallery’s left and right edges, along the bottom on a narrow or touch screen.
  - `autoplay` (integer, nullable): Plays the gallery as a slideshow, holding each image this many seconds: 3 to 60. `null` is off. Slideshows are part of paid plans.
  - `motion` (enum): How a slideshow holds each image. It matters only while the slideshow plays.
    - `drift`: Each image drifts slowly in toward its center.
    - `still`: Each image holds still.
  - `accent_color` (string, optional): The color the viewer highlights with, such as hover outlines, active controls and focus rings, as `#rgb` or `#rrggbb`. Left out, the viewer keeps ZoomHub’s own.
- `image` (object, optional): Present when `type` is `image`: the image it shows and how.
  - `content_id` (string): The image the viewer shows, by content ID. It must belong to the viewer’s owner.
  - `heading` (enum): What shows in the top-left corner.
    - `mark`: The ZoomHub logo.
    - `hidden`: Nothing. Hiding the logo is part of paid plans.
  - `controls` (array of strings): The controls the viewer shows, each at most once; an empty array shows none.
    - `zoom`: Zoom in and out.
    - `reset`: Return to the whole image.
    - `fullscreen`: Fill the screen.
    - `share`: Share the image.
    - `view_original`: Open the original file.
  - `minimap` (enum): Whether the navigator shows in the top-right corner.
    - `shown`
    - `hidden`
  - `metadata` (enum): Whether the image’s pixel dimensions show in the top-right corner.
    - `shown`
    - `hidden`
  - `background` (enum): The backdrop behind the image.
    - `black`: Black.
    - `white`: White.
    - `none`: Transparent: the page shows through.
  - `fit` (enum): How the image sits in its frame before anyone zooms.
    - `contain`: The whole image, letterboxed.
    - `cover`: The frame filled, the image cropped.
  - `accent_color` (string, optional): The color the viewer highlights with, such as hover outlines, active controls and focus rings, as `#rgb` or `#rrggbb`. Left out, the viewer keeps ZoomHub’s own.
  - `constrain` (enum, optional): How far visitors may zoom out and pan. Left out, they may zoom out a little past the fitted view and pan loosely.
    - `zoom`: No further out than the fitted view.
    - `full`: No further out than the fitted view, and never past the image’s edges.
- `links` (object): Where the viewer lives.
  - `self` (string): This viewer in the API.
  - `share` (string): The viewer’s page on ZoomHub.
  - `embed` (string): A page made for an `<iframe>`.
  - `script` (string): A script that puts the viewer where its `<script>` tag is.

**Example 1**

```json
{
  "gallery": {
    "arrows": "controls",
    "autoplay": null,
    "background": "black",
    "captions": "shown",
    "collection_id": "Smp7Set9Abc",
    "controls": "full",
    "layout": "justified",
    "motion": "drift",
    "navigation": "arrows"
  },
  "id": "Smp7View9Ab",
  "links": {
    "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
    "script": "https://zoomhub.net/v/Smp7View9Ab.js",
    "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
    "share": "https://zoomhub.net/v/Smp7View9Ab"
  },
  "object": "viewer",
  "title": "Sample gallery",
  "type": "gallery"
}
```

**Example 2**

```json
{
  "id": "Smp7View9Ab",
  "image": {
    "background": "white",
    "constrain": "full",
    "content_id": "Smp7Pic",
    "controls": [
      "zoom",
      "view_original"
    ],
    "fit": "cover",
    "heading": "hidden",
    "metadata": "hidden",
    "minimap": "shown"
  },
  "links": {
    "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
    "script": "https://zoomhub.net/v/Smp7View9Ab.js",
    "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
    "share": "https://zoomhub.net/v/Smp7View9Ab"
  },
  "object": "viewer",
  "title": "Press kit",
  "type": "image"
}
```

**Example 3**

```json
{
  "gallery": {
    "accent_color": "#3a8fd9",
    "arrows": "controls",
    "autoplay": 8,
    "background": "black",
    "captions": "shown",
    "collection_id": "Smp7Set9Abc",
    "controls": "full",
    "layout": "justified",
    "motion": "drift",
    "navigation": "arrows"
  },
  "id": "Smp7View9Ab",
  "links": {
    "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
    "script": "https://zoomhub.net/v/Smp7View9Ab.js",
    "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
    "share": "https://zoomhub.net/v/Smp7View9Ab"
  },
  "object": "viewer",
  "title": "Sample gallery",
  "type": "gallery"
}
```

**Example 4**

```json
{
  "id": "Smp7View9Ab",
  "image": {
    "accent_color": "#3a8fd9",
    "background": "white",
    "constrain": "full",
    "content_id": "Smp7Pic",
    "controls": [
      "zoom",
      "view_original"
    ],
    "fit": "cover",
    "heading": "hidden",
    "metadata": "hidden",
    "minimap": "shown"
  },
  "links": {
    "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
    "script": "https://zoomhub.net/v/Smp7View9Ab.js",
    "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
    "share": "https://zoomhub.net/v/Smp7View9Ab"
  },
  "object": "viewer",
  "title": "Press kit",
  "type": "image"
}
```

### Create a viewer — `POST /v2/viewers`

**Authentication:** API key. Send an API key.

Creates a gallery for a collection, or a viewer for an image.

Only the owner of the collection or image, or an admin, may create a viewer for it, and the viewer belongs to that owner. Options you leave out take their defaults.

**Body parameters**

- `type` (enum, required): What the viewer shows. Send its options under the key of the same name.
  - `gallery`: Shows a collection.
  - `image`: Shows one image.
- `title` (string, optional, nullable): The viewer’s title. At most 250 characters on a single line, and not empty; surrounding whitespace is trimmed.
- `gallery` (object, optional): Required when `type` is `gallery`.
  - `collection_id` (string, required): The collection the gallery shows. It must belong to the viewer’s owner.
  - `layout` (enum, optional): How the gallery lays out its images. Every layout keeps the collection’s order. Defaults to `justified`.
    - `justified`: Rows of equal height, filled edge to edge.
    - `grid`: Equal cells.
    - `strip`: One row to scroll through.
  - `background` (string, optional): The gallery’s backdrop: `black`, `white`, or a hex color such as `#1c1c1f`. Defaults to `black`.
  - `captions` (enum, optional): Whether each image’s title shows beneath it. Defaults to `shown`.
    - `shown`
    - `hidden`
  - `controls` (enum, optional): Which controls the gallery shows. Defaults to `full`.
    - `full`: Every control, including the layout toggle.
    - `minimal`: Only the essential controls.
    - `fixed-layout`: Every control but the layout toggle: opening an image frames it closely, and going home steps back to the wall.
  - `navigation` (enum, optional): How visitors move between images. Defaults to `arrows`.
    - `arrows`: Previous and next arrows.
    - `numbers`: A ribbon of numbered pills on top, one per image.
  - `arrows` (enum, optional): Where the previous and next arrows sit. Defaults to `controls`.
    - `controls`: With the other controls.
    - `sides`: As large buttons on the gallery’s left and right edges, along the bottom on a narrow or touch screen.
  - `autoplay` (integer, optional, nullable): Plays the gallery as a slideshow, holding each image this many seconds: 3 to 60. `null` is off. Slideshows are part of paid plans. Defaults to `null`.
  - `motion` (enum, optional): How a slideshow holds each image. It matters only while the slideshow plays. Defaults to `drift`.
    - `drift`: Each image drifts slowly in toward its center.
    - `still`: Each image holds still.
  - `accent_color` (string, optional): The color the viewer highlights with, such as hover outlines, active controls and focus rings, as `#rgb` or `#rrggbb`. Left out, the viewer keeps ZoomHub’s own.
- `image` (object, optional): Required when `type` is `image`.
  - `content_id` (string, required): The image the viewer shows, by content ID. It must belong to the viewer’s owner.
  - `heading` (enum, optional): What shows in the top-left corner. Defaults to `mark`.
    - `mark`: The ZoomHub logo.
    - `hidden`: Nothing. Hiding the logo is part of paid plans.
  - `controls` (array of strings, optional): The controls the viewer shows, each at most once; an empty array shows none. Defaults to `every control`.
    - `zoom`: Zoom in and out.
    - `reset`: Return to the whole image.
    - `fullscreen`: Fill the screen.
    - `share`: Share the image.
    - `view_original`: Open the original file.
  - `minimap` (enum, optional): Whether the navigator shows in the top-right corner. Defaults to `hidden`.
    - `shown`
    - `hidden`
  - `metadata` (enum, optional): Whether the image’s pixel dimensions show in the top-right corner. Defaults to `shown`.
    - `shown`
    - `hidden`
  - `background` (enum, optional): The backdrop behind the image. Defaults to `black`.
    - `black`: Black.
    - `white`: White.
    - `none`: Transparent: the page shows through.
  - `fit` (enum, optional): How the image sits in its frame before anyone zooms. Defaults to `contain`.
    - `contain`: The whole image, letterboxed.
    - `cover`: The frame filled, the image cropped.
  - `accent_color` (string, optional): The color the viewer highlights with, such as hover outlines, active controls and focus rings, as `#rgb` or `#rrggbb`. Left out, the viewer keeps ZoomHub’s own.
  - `constrain` (enum, optional): How far visitors may zoom out and pan. Left out, they may zoom out a little past the fitted view and pan loosely.
    - `zoom`: No further out than the fitted view.
    - `full`: No further out than the fitted view, and never past the image’s edges.

**Responses**

- `201 Created`: The new viewer object.
- `400 Bad Request`, error code `bad_request`: The body isn’t JSON, misses a required key, has a key the endpoint doesn’t know, or breaks a limit. The detail says which.
- `400 Bad Request`, error code `bad_request`: The collection or image has no owner, so it can’t have a viewer.
- `401 Unauthorized`, error code `not_authenticated`: No `Authorization` header.
- `401 Unauthorized`, error code `invalid_api_key`: The key is unknown or revoked, or the header isn’t a `Bearer` key.
- `403 Forbidden`, error code `plan_required`: The key is valid, but its account’s plan doesn’t include the API.
- `403 Forbidden`, error code `forbidden`: The key’s account neither owns what the viewer shows nor is an admin.
- `403 Forbidden`, error code `subscription_required`: The owner’s plan doesn’t include an option you set: hiding the logo, or a slideshow.
- `404 Not Found`, error code `not_found`: The collection doesn’t exist.
- `404 Not Found`, error code `content_not_found`: The image doesn’t exist.

**Request**

```bash
curl "https://api.zoomhub.net/v2/viewers" \
  --header "Authorization: Bearer $ZOOMHUB_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "gallery": {
      "collection_id": "Smp7Set9Abc"
    },
    "title": "Sample gallery",
    "type": "gallery"
  }'
```

**Response** `201 Created`

```json
{
  "gallery": {
    "arrows": "controls",
    "autoplay": null,
    "background": "black",
    "captions": "shown",
    "collection_id": "Smp7Set9Abc",
    "controls": "full",
    "layout": "justified",
    "motion": "drift",
    "navigation": "arrows"
  },
  "id": "Smp7View9Ab",
  "links": {
    "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
    "script": "https://zoomhub.net/v/Smp7View9Ab.js",
    "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
    "share": "https://zoomhub.net/v/Smp7View9Ab"
  },
  "object": "viewer",
  "title": "Sample gallery",
  "type": "gallery"
}
```

### Retrieve a viewer — `GET /v2/viewers/{id}`

**Authentication:** API key optional. Works without a key; a key opens your own Protected items.

Returns the viewer with the given ID.

Anyone may read a viewer whose collection or image they may view. Its owner may always read it: send the owner’s key.

> **Note:** Reading what isn’t Protected needs no key: leave out the `Authorization` header. A key that fails to verify counts as no key: what’s public answers as usual, and what’s Protected answers `403` `forbidden`.

**Path parameters**

- `id` (string, required): The viewer’s ID.

**Responses**

- `200 OK`: The viewer object.
- `403 Forbidden`, error code `forbidden`: The collection or image the viewer shows is Protected and the key’s account may not view it. The answer is the same whatever the reason, so it doesn’t reveal which rule refused.
- `404 Not Found`, error code `not_found`: No viewer has this ID, it was deleted, or what it shows was.

**Request**

```bash
curl "https://api.zoomhub.net/v2/viewers/Smp7View9Ab"
```

**Response** `200 OK`

```json
{
  "gallery": {
    "arrows": "controls",
    "autoplay": null,
    "background": "black",
    "captions": "shown",
    "collection_id": "Smp7Set9Abc",
    "controls": "full",
    "layout": "justified",
    "motion": "drift",
    "navigation": "arrows"
  },
  "id": "Smp7View9Ab",
  "links": {
    "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
    "script": "https://zoomhub.net/v/Smp7View9Ab.js",
    "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
    "share": "https://zoomhub.net/v/Smp7View9Ab"
  },
  "object": "viewer",
  "title": "Sample gallery",
  "type": "gallery"
}
```

### List viewers — `GET /v2/viewers`

**Authentication:** API key optional. Works without a key; a key opens your own Protected items.

Returns the viewers of a collection or of an image.

Name exactly one of `collection_id` and `content_id`. A collection or image that doesn’t exist has no viewers, so it answers an empty list rather than `404`.

> **Note:** Reading what isn’t Protected needs no key: leave out the `Authorization` header. A key that fails to verify counts as no key: what’s public answers as usual, and what’s Protected answers `403` `forbidden`.

**Query parameters**

- `collection_id` (string, optional): List the galleries of this collection.
- `content_id` (string, optional): List the viewers of this image.

**Responses**

- `200 OK`: A list object whose `data` holds the viewer objects; empty when there are none.
- `400 Bad Request`, error code `bad_request`: Both `collection_id` and `content_id` were sent, or neither.
- `400 Bad Request`, error code `bad_request`: The `collection_id` or `content_id` can’t be an ID.
- `403 Forbidden`, error code `forbidden`: The collection or image is Protected and the key’s account may not view it. The answer is the same whatever the reason, so it doesn’t reveal which rule refused.

**Request**

```bash
curl "https://api.zoomhub.net/v2/viewers?collection_id=Smp7Set9Abc"
```

**Response** `200 OK`

```json
{
  "data": [
    {
      "gallery": {
        "arrows": "controls",
        "autoplay": null,
        "background": "black",
        "captions": "shown",
        "collection_id": "Smp7Set9Abc",
        "controls": "full",
        "layout": "justified",
        "motion": "drift",
        "navigation": "arrows"
      },
      "id": "Smp7View9Ab",
      "links": {
        "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
        "script": "https://zoomhub.net/v/Smp7View9Ab.js",
        "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
        "share": "https://zoomhub.net/v/Smp7View9Ab"
      },
      "object": "viewer",
      "title": "Sample gallery",
      "type": "gallery"
    }
  ],
  "has_more": false,
  "object": "list"
}
```

### Update a viewer — `PATCH /v2/viewers/{id}`

**Authentication:** API key. Send an API key.

Changes a viewer’s title, options, or what it shows.

Only the viewer’s owner, or an admin, may update it. Send only what changes: an option you leave out keeps its value. Send options under the viewer’s own type; its type can’t change.

> **Note:** A downgraded owner keeps a slideshow or a hidden logo set before, and can still change other options; turning either on again takes a paid plan.

**Path parameters**

- `id` (string, required): The viewer’s ID.

**Body parameters**

- `type` (enum, optional): Accepted and ignored when it names a viewer type, since a viewer’s type can’t change; any other value is refused.
  - `gallery`: Shows a collection.
  - `image`: Shows one image.
- `title` (string, optional, nullable): The new title; `null` removes it. At most 250 characters on a single line, and not empty; surrounding whitespace is trimmed.
- `gallery` (object, optional): A gallery’s options to change.
  - `collection_id` (string, optional): The collection the gallery shows. It must belong to the viewer’s owner.
  - `layout` (enum, optional): How the gallery lays out its images. Every layout keeps the collection’s order.
    - `justified`: Rows of equal height, filled edge to edge.
    - `grid`: Equal cells.
    - `strip`: One row to scroll through.
  - `background` (string, optional): The gallery’s backdrop: `black`, `white`, or a hex color such as `#1c1c1f`.
  - `captions` (enum, optional): Whether each image’s title shows beneath it.
    - `shown`
    - `hidden`
  - `controls` (enum, optional): Which controls the gallery shows.
    - `full`: Every control, including the layout toggle.
    - `minimal`: Only the essential controls.
    - `fixed-layout`: Every control but the layout toggle: opening an image frames it closely, and going home steps back to the wall.
  - `navigation` (enum, optional): How visitors move between images.
    - `arrows`: Previous and next arrows.
    - `numbers`: A ribbon of numbered pills on top, one per image.
  - `arrows` (enum, optional): Where the previous and next arrows sit.
    - `controls`: With the other controls.
    - `sides`: As large buttons on the gallery’s left and right edges, along the bottom on a narrow or touch screen.
  - `autoplay` (integer, optional, nullable): Plays the gallery as a slideshow, holding each image this many seconds: 3 to 60. `null` is off. Slideshows are part of paid plans.
  - `motion` (enum, optional): How a slideshow holds each image. It matters only while the slideshow plays.
    - `drift`: Each image drifts slowly in toward its center.
    - `still`: Each image holds still.
  - `accent_color` (string, optional, nullable): The color the viewer highlights with, such as hover outlines, active controls and focus rings, as `#rgb` or `#rrggbb`. Left out, the viewer keeps ZoomHub’s own. `null` removes it.
- `image` (object, optional): An image viewer’s options to change.
  - `content_id` (string, optional): The image the viewer shows, by content ID. It must belong to the viewer’s owner.
  - `heading` (enum, optional): What shows in the top-left corner.
    - `mark`: The ZoomHub logo.
    - `hidden`: Nothing. Hiding the logo is part of paid plans.
  - `controls` (array of strings, optional): The controls the viewer shows, each at most once; an empty array shows none.
    - `zoom`: Zoom in and out.
    - `reset`: Return to the whole image.
    - `fullscreen`: Fill the screen.
    - `share`: Share the image.
    - `view_original`: Open the original file.
  - `minimap` (enum, optional): Whether the navigator shows in the top-right corner.
    - `shown`
    - `hidden`
  - `metadata` (enum, optional): Whether the image’s pixel dimensions show in the top-right corner.
    - `shown`
    - `hidden`
  - `background` (enum, optional): The backdrop behind the image.
    - `black`: Black.
    - `white`: White.
    - `none`: Transparent: the page shows through.
  - `fit` (enum, optional): How the image sits in its frame before anyone zooms.
    - `contain`: The whole image, letterboxed.
    - `cover`: The frame filled, the image cropped.
  - `accent_color` (string, optional, nullable): The color the viewer highlights with, such as hover outlines, active controls and focus rings, as `#rgb` or `#rrggbb`. Left out, the viewer keeps ZoomHub’s own. `null` removes it.
  - `constrain` (enum, optional, nullable): How far visitors may zoom out and pan. Left out, they may zoom out a little past the fitted view and pan loosely. `null` removes it.
    - `zoom`: No further out than the fitted view.
    - `full`: No further out than the fitted view, and never past the image’s edges.

**Responses**

- `200 OK`: The updated viewer object.
- `400 Bad Request`, error code `bad_request`: The body isn’t JSON, misses a required key, has a key the endpoint doesn’t know, or breaks a limit. The detail says which.
- `400 Bad Request`, error code `bad_request`: The options were sent under the other viewer type.
- `400 Bad Request`, error code `subject_owner_mismatch`: The new collection or image belongs to someone other than the viewer’s owner.
- `401 Unauthorized`, error code `not_authenticated`: No `Authorization` header.
- `401 Unauthorized`, error code `invalid_api_key`: The key is unknown or revoked, or the header isn’t a `Bearer` key.
- `403 Forbidden`, error code `plan_required`: The key is valid, but its account’s plan doesn’t include the API.
- `403 Forbidden`, error code `forbidden`: The key’s account neither owns what the viewer shows nor is an admin.
- `403 Forbidden`, error code `subscription_required`: The owner’s plan doesn’t include an option you turned on: hiding the logo, or a slideshow.
- `404 Not Found`, error code `not_found`: No viewer has this ID, or the new collection doesn’t exist.
- `404 Not Found`, error code `content_not_found`: The new image doesn’t exist.

**Request**

```bash
curl "https://api.zoomhub.net/v2/viewers/Smp7View9Ab" \
  --request PATCH \
  --header "Authorization: Bearer $ZOOMHUB_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "gallery": {
      "accent_color": null,
      "captions": "shown"
    },
    "title": "Sample gallery"
  }'
```

**Response** `200 OK`

```json
{
  "gallery": {
    "arrows": "controls",
    "autoplay": null,
    "background": "black",
    "captions": "shown",
    "collection_id": "Smp7Set9Abc",
    "controls": "full",
    "layout": "justified",
    "motion": "drift",
    "navigation": "arrows"
  },
  "id": "Smp7View9Ab",
  "links": {
    "embed": "https://zoomhub.net/v/Smp7View9Ab/embed",
    "script": "https://zoomhub.net/v/Smp7View9Ab.js",
    "self": "https://api.zoomhub.net/v2/viewers/Smp7View9Ab",
    "share": "https://zoomhub.net/v/Smp7View9Ab"
  },
  "object": "viewer",
  "title": "Sample gallery",
  "type": "gallery"
}
```

### Delete a viewer — `DELETE /v2/viewers/{id}`

**Authentication:** API key. Send an API key.

Deletes a viewer, but not what it shows.

Only the viewer’s owner, or an admin, may delete it, whatever the owner’s plan. Its page and embeds answer `404` from then on.

**Path parameters**

- `id` (string, required): The viewer’s ID.

**Responses**

- `204 No Content`: Deleted.
- `401 Unauthorized`, error code `not_authenticated`: No `Authorization` header.
- `401 Unauthorized`, error code `invalid_api_key`: The key is unknown or revoked, or the header isn’t a `Bearer` key.
- `403 Forbidden`, error code `plan_required`: The key is valid, but its account’s plan doesn’t include the API.
- `403 Forbidden`, error code `forbidden`: The key’s account neither owns what the viewer shows nor is an admin.
- `404 Not Found`, error code `not_found`: No viewer has this ID, or it was deleted.

**Request**

```bash
curl "https://api.zoomhub.net/v2/viewers/Smp7View9Ab" \
  --request DELETE \
  --header "Authorization: Bearer $ZOOMHUB_API_KEY"
```