---
title: "Rename workspace"
method: PATCH
path: "/v1/workspace"
tags: ["workspace"]
---

# Rename workspace

`PATCH /v1/workspace`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/workspace`
- Auth: HTTP bearer

Renames the workspace. The name must be non-empty and no more than 120 characters. Requires permission to edit billing for the whole workspace.

**Notes.**
- Only `name` can be changed here.

## Request body

- object
  - `name` string, required: Trimmed; 1–120 characters.

## Response `200`

Success.

- object
  - `data` object, required
    - `id` string, required
    - `name` string, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold `billing.edit` for the whole workspace (a grant at one location is not enough).
- `422`: `invalid`: `name` missing, empty or over 120 characters.
- `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)