---
title: "End a cast"
method: POST
path: "/v1/casts/{id}/clear"
tags: ["casts"]
---

# End a cast

`POST /v1/casts/{id}/clear`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/casts/{id}/clear`
- Auth: HTTP bearer

End a cast immediately and return its screens to their scheduled content.

Ends an active cast; its screens return to their scheduled content immediately.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` Override, required: A cast or an emergency override.
    - `id` string, required: Override (cast_… or emg_…) id.
    - `spaceId` string, required: Workspace id.
    - `kind` 'emergency' | 'cast', required
    - `status` 'active' | 'cleared' | 'expired', required
    - `severity` 'info' | 'warning' | 'critical', required: Always `info` for a cast.
    - `headline` string, required: An emergency's message; for a cast, the content's name (or "Cast").
    - `body` string, nullable, required
    - `contentKind` 'media' | 'creative' | 'playlist' | 'app' | 'schedule', nullable, required
    - `contentId` string, nullable, required
    - `contentName` string, nullable, required: Name of the content on air: for a cast, the label it was started with (a quick post's headline), else the content's current name; null when there is no content or it no longer exists.
    - `scopeKind` 'all' | 'node' | 'screens', required
    - `scopeNodeId` string, nullable, required: The location, when `scopeKind` is `node`.
    - `nodeId` string, nullable, required: Location the override is attributed to (null = workspace root).
    - `screenCount` integer, required: Screens targeted, snapshotted when it started.
    - `triggeredBy` string, required: User id, or `system`.
    - `triggeredAt` string, required: ISO-8601 timestamp (UTC).
    - `expiresAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `clearedBy` string, nullable, required
    - `clearedAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `triggeredByName` string, required: Display name of `triggeredBy`.
    - `clearedByName` string, nullable, required
    - `scopeName` string, nullable, required: Location name, `All screens`, or null for a screen list.
    - `confirmedCount` integer, nullable, required: Active emergencies only: screens confirmed showing it now. Null otherwise.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No such cast in this workspace.
- `409`: `already_inactive`: the cast is already cleared or expired.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/7c2741bcdb16?raw)