# workspace.rename

`PATCH /api/public/v1/workspace`

Rename the workspace (optimistic revision check).

- Capability: `workspace.update`
- Command: yes — send a `command_id`; resending the same id and body returns the stored receipt
- MCP tool: `workspace_rename`

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `command_id` | body | string (uuid) | yes | Client-generated UUID for this command. Send the same id (and body) again to get the stored receipt instead of a second change; a different body under the same id is CONFLICT. |
| `expected_revision` | body | integer | yes | The revision you last read; a newer revision on the server is CONFLICT (min 1, max 9007199254740991) |
| `name` | body | string | yes | (min length 1, max length 80) |

## Response

`201` with `{ data, replayed: false, correlation_id }` the first time; `200` with `replayed: true` for a repeated `command_id`.

The field list of this reply is not published yet; read `data` as JSON.

## Errors

| Code | HTTP | Retryable |
|---|---|---|
| `UNAUTHENTICATED` | 401 | no |
| `FORBIDDEN` | 403 | no |
| `RATE_LIMITED` | 429 | yes |
| `VALIDATION_FAILED` | 422 | no |
| `CONFLICT` | 409 | no |
| `OUTCOME_UNKNOWN` | 202 | yes |
| `DEPENDENCY_UNAVAILABLE` | 503 | yes |
| `UNKNOWN` | 500 | no |

## Example (curl)

```bash
curl -X PATCH "https://browlix.com/api/public/v1/workspace" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>","expected_revision":1,"name":"<name>"}'
```

## Example (TypeScript SDK)

```ts
import { Browlix } from "@browlix/sdk";

const bx = new Browlix({ apiKey: process.env.BROWLIX_API_KEY! });
const reply = await bx.call("workspace.rename", { body: {"expected_revision":1,"name":"<name>"} });
console.log(reply.data);
```

## Example (Python)

```python
import os, uuid
import requests

r = requests.patch(
    "https://browlix.com/api/public/v1/workspace",
    headers={"Authorization": f"Bearer {os.environ['BROWLIX_API_KEY']}"},
    json={"command_id":str(uuid.uuid4()),"expected_revision":1,"name":"<name>"},
    timeout=60,
)
print(r.status_code, r.json())
```

## Example (MCP)

```json
{
  "method": "tools/call",
  "params": {
    "name": "workspace_rename",
    "arguments": {
      "expected_revision": 1,
      "name": "<name>"
    }
  }
}
```
