---
title: "Update a workspace"
method: PATCH
path: "/v2/workspaces/{workspaceId}"
tags: ["Workspaces"]
---

# Update a workspace

`PATCH /v2/workspaces/{workspaceId}`

## Request

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

This endpoint updates the name of an existing workspace identified by its workspaceId.

### Usage notes
- Set `NoDuplicates` to `true` to prevent the creation of a duplicate workspace.
- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.

### Usage scenarios
- **Configuration change**: Allows users to update workspace settings or names as projects evolve or requirements change.
- **Access control adjustments**: Update workspace details in response to organizational changes or policy updates.

### Best practices
- **Partial updates**: Use PATCH to support partial updates, only sending the fields that need to be updated.
- **Validation**: Validate input data to ensure it adheres to expected formats and constraints. Handle errors gracefully and inform the user of any constraints.

## Path parameters

- `workspaceId` string, required

## Request body

- object
  - `name` string, required: Name of the new workspace.
  - `noDuplicates` boolean: Set to true to avoid creating a workspace with a duplicate name.

## Response `200`

The response body.

- WorkspacesUpdateWorkspaceResponse200
  - `workspaceId` string, required
  - `workspaceUrlId` string, required: Base62-encoded identifier used in Sigma workspace URLs.
  - `name` string, required
  - `createdBy` string, required
  - `updatedBy` string, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)