---
title: "Update a banner"
method: PATCH
path: "/v1/banners/{id}"
tags: ["banners"]
---

# Update a banner

`PATCH /v1/banners/{id}`

## Request

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

Edit an announcement banner's title, body, tone, audience, or active state.

## Path parameters

- `id` string, required

## Request body

- object
  - `title` string
  - `body` string, nullable
  - `tone` 'info' | 'success' | 'warning' | 'critical': Default `info`.
  - `audience` object
  - `active` boolean: Default true.

## Response `200`

Success.

- object
  - `data` Banner, required: A workspace message banner shown on screens.
    - `id` string, required
    - `spaceId` string, required
    - `title` string, required
    - `body` string, nullable, required
    - `tone` 'info' | 'success' | 'warning' | 'critical', required
    - `audience` object, required: Free-form JSON the screens use to pick the banner (default `{}`).
    - `active` boolean, required
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).

## 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 banner in this workspace.
- `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)