---
title: "Rename a workspace."
method: POST
path: "/v0/workspaces/{workspaceId}/rename"
tags: ["Workspaces"]
---

# Rename a workspace.

`POST /v0/workspaces/{workspaceId}/rename`

## Request

- Base URL: `https://api.conductor.build` (the document declares no server; this is the origin it was published from)
- URL: `https://api.conductor.build/v0/workspaces/{workspaceId}/rename`
- Auth: HTTP bearer

## Path parameters

- `workspaceId` string, required

## Query parameters

- `channel` 'prod' | 'alpha' | 'alpha-chromium' | 'beta' | 'patch' | 'dev' | 'funhouse'

## Request body

- object
  - `name` string, required

## Response `200`

Default Response

- object
  - `id` string, required
  - `projectId` string
  - `name` string, required
  - `number` number
  - `state` union, required
    - 'initializing'
    - 'ready'
    - 'sleeping'
    - 'archived'
    - 'deleted'
    - 'updating'
    - 'unstarted'
  - `lifecycleStep` union
    - 'building_snapshot'
    - 'preparing'
    - 'setting_up'
    - 'updating'
  - `repoUrl` string, required
  - `createdAt` string, required
  - `deepLink` string, required
  - `creatorId` string
  - `creatorName` string: Display name of the member who created the workspace.
  - `lastActivityAt` string

## Other responses

- `400`: Invalid request.
- `401`: Missing or invalid bearer token.
- `404`: Resource not found.
- `default`: Error response.

---

[API](https://skmtc.dev/conductor-build/apis/roundhouse-public-api.md) - [All operations](https://skmtc.dev/conductor-build/apis/roundhouse-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conductor-build/apis/roundhouse-public-api/revisions/1f39c7f7f219?raw)