PermuteDocs
Dashboard

Workspaces · workspacesDelete

Delete a workspace

Soft-deletes a workspace when the key has workspace admin access.

DELETE/v1/workspaces/{workspaceId}
betaapiKeyorganization

When to use

Remove a workspace that should no longer be available.

For agents

Requires workspace admin access. Deletion is destructive from the caller perspective; do not use it as routine cleanup.

Example

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

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

const result = await orgClient.workspaces.delete('wksp_finance123');

Response

json
{
  "data": {
    "id": "wksp_finance123",
    "deleted": true
  }
}