---
title: "Rename a screen group"
method: PATCH
path: "/v1/screen-groups/{id}"
tags: ["screen-groups"]
---

# Rename a screen group

`PATCH /v1/screen-groups/{id}`

## Request

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

Update a screen group's name or description. A name already used by another group in your workspace is refused with a `name_taken` conflict error.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `description` string, nullable

## Response `200`

Success.

- object
  - `data` ScreenGroup, required: A named, saved set of screens — the unit for bulk commands and casts.
    - `id` string, required: Screen group id.
    - `name` string, required
    - `description` string, nullable, required
    - `screenCount` integer, required: Members the caller can see.
    - `screenIds` string[], required: Member screen ids the caller can see, oldest membership first.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, 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 screen group with this id.
- `409`: `name_taken`.
- `422`: `name` is empty.
- `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)