---
title: "Rename the workspace"
description: "Change the workspace's name. `PATCH /api/v1/workspace`"
url: https://www.unitpost.com/docs/platform/patch-workspace
section: "Platform API reference"
updated: 2026-10-13
---
# Rename the workspace

`PATCH /api/v1/workspace`

Change the workspace's name. Deleting the workspace stays in the dashboard. Requires the `branding:write` capability.

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | The workspace's new name. |

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `id` | string | yes | — |
| `name` | string | yes | — |
| `slug` | string | yes | — |
| `image_url` | string \| null | yes | The workspace image (its avatar in the dashboard). |

## Responses

| Status | Description |
| --- | --- |
| 200 | The workspace. |
| 400 | The body isn't JSON. |
| 401 | Missing or invalid API key. |
| 403 | Insufficient scope. |
| 422 | A bad `name`, or an unknown key. |

## Example request

```bash
curl -X PATCH 'https://www.unitpost.com/api/v1/workspace' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
```

## Example response (200)

```json
{
  "object": "workspace",
  "id": "id_123",
  "name": "Example",
  "slug": "string",
  "image_url": "https://example.com"
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/platform/patch-workspace
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json