Update a workspace – PATCH /v1/workspaces/{workspaceId}

PATCH/v1/workspaces/{workspaceId}

betaapiKeyorganization

When to use

Change a workspace name or business context.

For agents

Requires workspace write access. Send only the fields that should change; at least one field is required.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const result = await orgClient.workspaces.update('wksp_finance123', {
  "name": "Finance and Operations"
});

Request body

json

{
  "name": "Finance and Operations"
}

Response

json

{
  "data": {
    "id": "wksp_finance123",
    "organizationId": "org_acme123",
    "name": "Finance and Operations",
    "context": "Revenue, customers, and operating performance",
    "visibility": "private",
    "createdAt": "2026-07-14T12:00:00.000Z",
    "updatedAt": "2026-07-14T12:05:00.000Z"
  }
}