---
title: "Rename a workspace."
method: PATCH
path: "/v1/workspaces/{workspaceId}"
---

# Rename a workspace.

`PATCH /v1/workspaces/{workspaceId}`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}`
- Auth: HTTP bearer

Requires an active owner or admin; credentials need workspace:admin for this workspace. The name is trimmed and must be 1-80 characters. A typed name is final: later brand confirmations no longer rename the workspace (name_source becomes user). Bumps the workspace revision and records a "workspace" change.

## Request body

- object
  - `name` string, required

## Response `200`

The workspace was renamed.

- object
  - `data` RenamedWorkspace, required
    - `id` string, uuid, required
    - `name` string, required
    - `name_source` 'user', required

## Other responses

- `400`: invalid_workspace_name: the trimmed name is empty or longer than 80 characters.
- `403`: The actor is not an owner or admin, or the credential lacks workspace:admin.
- `404`: The workspace does not exist or is not available to this actor.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/0705eb6ef2bc?raw)