---
title: "Rename a workspace"
method: PATCH
path: "/api/v1/me/workspaces/{workspace_id}"
tags: ["me"]
---

# Rename a workspace

`PATCH /api/v1/me/workspaces/{workspace_id}`

## Request

- Base URL: `https://api.cadencz.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.cadencz.com/api/v1/me/workspaces/{workspace_id}`
- Auth: HTTP bearer

## Path parameters

- `workspace_id` string, required

## Request body

- WorkspaceUpdateRequest
  - `name` string, required

## Response `200`

Successful Response

- WorkspaceDetail: A workspace as the management screen needs it: identity, plus enough of what is inside to make deleting it a decision rather than a guess.
  - `id` string, required
  - `ownerId` string, required
  - `name` string, required
  - `handle` string, required
  - `avatarUrl` string, nullable, required
  - `createdAt` string, required
  - `isCurrent` boolean, required
  - `paused` boolean
  - `channels` integer, required
  - `brains` integer, required
  - `posts` integer, required
  - `scheduled` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Validation Error

---

[API](https://skmtc.dev/cadencz/apis/cadencz-api.md) · [All operations](https://skmtc.dev/cadencz/apis/cadencz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cadencz/apis/cadencz-api/revisions/3392fe5e93db?raw)