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

# Update a workspace

`PATCH /workspaces/{id}`

## Request

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

Rename, recolour, change the icon or reorder a workspace.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string: Up to 48 characters.
  - `color` string, nullable: A palette colour, or `null` to clear it. An unknown colour also clears it.
  - `icon` string, nullable: One emoji, or `null` to clear it.
  - `position` integer: Sort position, 0 to 999.

## Response `200`

Update a workspace

- object
  - `id` string: The workspace id.
  - `name` string: Its name.
  - `color` string, nullable: A hex colour, or `null` when none is set.
  - `icon` string, nullable: An emoji, or `null`.
  - `teamId` string, nullable: The team it belongs to, or `null` for a personal workspace.
  - `projectCount` integer: Projects filed in it (0 for a new one).

## Other responses

- `400`: `invalid_request`: Nothing to change, or an empty name.
- `404`: `not_found`: No such workspace.

---

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