---
title: "Recall a schedule from all screens"
method: POST
path: "/v1/recall/schedule/{id}"
tags: ["recall"]
---

# Recall a schedule from all screens

`POST /v1/recall/schedule/{id}`

## Request

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

Immediately remove a schedule from every screen it appears on, without deleting it or changing any playlist. This applies regardless of any approval settings at the affected locations. The action is reversible, and the underlying rotation is left untouched.

**Notes.**
- A flag, not an edit: no playlist, screen or schedule changes, and the item stays in the library. Screens are told at once.

## Path parameters

- `id` string, required

## Request body

- object
  - `reason` string: Why it was recalled. Kept in the activity log and sent with the `content.recalled` webhook.

## Response `200`

Success.

- object
  - `data` object, required
    - `id` string, required
    - `kind` 'media' | 'creative' | 'playlist' | 'schedule', required
    - `recalledAt` string, required: ISO-8601 timestamp (UTC).
    - `recalledBy` string, required: Who recalled it. An actor reference: `user:<id>`, `apikey:<id>`, `staff:<email>`, `partner:<email>` or `system…`.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold `schedule.edit` where the schedule lives.
- `404`: No such schedule in this workspace.
- `409`: `already_recalled`: it is already recalled.
- `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/02fd3665dc7d?raw)