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

# Update a workspace

`PATCH /api/workspaces/{workspaceId}`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}`
- Auth: API key in cookie `hiveship_access`

## Path parameters

- `workspaceId` string, required

## Response `200`

Workspace updated

- object
  - `success` boolean, required
  - `data` object, required
    - `id` string, cuid, required
    - `name` string, required
    - `slug` string, required
    - `logoUrl` string, nullable, required
    - `brandColor` string, required
    - `autoLogAgentTime` boolean, required
    - `memberCount` integer, required
    - `agentCount` integer, required
    - `plan` 'FREE' | 'PRO' | 'TEAM' | 'ENTERPRISE', required
    - `createdAt` string, date-time, required

## Other responses

- `400`: Validation error
- `403`: Insufficient permissions
- `409`: Slug already taken

---

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