---
title: "Rename a Workspace the person owns."
method: PATCH
path: "/api/v2/workspaces/{id}"
---

# Rename a Workspace the person owns.

`PATCH /api/v2/workspaces/{id}`

## Request

- Base URL: `https://fintable.io`
- URL: `https://fintable.io/api/v2/workspaces/{id}`
- Auth: HTTP bearer

Requires the Owner role (403 otherwise). The Workspace must be selectable by the credential (default, legacy personal or granted); otherwise 404. Sandbox defaults to true in development and false in production. Only the Owner may change mode, and only while the Workspace has no connections, data, destinations or pending links.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `sandbox` boolean: Sandbox Workspace: new bank links use supported test environments. Existing connection environments never change.

## Response `200`

The updated Workspace.

- WorkspaceObject
  - `data` Workspace
    - `id` string: Opaque public Workspace ID (ws_...) — the value accepted by the workspace_id query parameter.
    - `name` string
    - `role` 'owner' | 'admin' | 'editor' | 'viewer' | 'null', nullable: The credential's person's role in this Workspace. It caps what any credential may do there: a write the role does not allow returns 403.
    - `is_default` boolean: True for the oldest owned Workspace, or the oldest Workspace the person belongs to when they own none, ordered by Workspace creation time. Used when workspace_id is omitted.
    - `created_at` string, date-time, nullable
    - `sandbox` boolean: Sandbox Workspace: new bank links use supported test environments. Existing connection environments never change.

## Other responses

- `403`: The standard error envelope.
- `404`: The standard error envelope.
- `422`: The standard error envelope.

---

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