Platform API reference

Platform API · Workspaces

patch/v1/workspaces/{workspace_slug}Auth

Update workspace display name, slug, or settings. Slug renames broadcast a `workspace.renamed` event so denormalised consumers (waitlist-api) sync.

Path parameters

workspace_slug*string

Slug of the workspace. Platform routes name the workspace by slug, positionally in the SDK (`platform.workspaces.retrieve("acme")`); the product APIs bind `workspace_id` instead.

Request body

display_namestring

New display name of the workspace.

Example: "Acme Corp"

slugstring

New URL-friendly slug. Same constraints as the create form. Renames are broadcast on the workspace events queue so denormalised consumers (waitlist-api, future product surfaces) can sync. Old URLs continue to resolve for one rename cycle.

Example: "acme"

settingsobject

Free-form workspace settings blob.

Response · 200 Workspace updated.

id*string · uuid

Id of the workspace.

slug*string

Unique URL-friendly slug; platform routes take it positionally.

Example: "acme-corp"

display_name*string

Display name of the workspace.

Example: "Acme Corp"

created_by*string · uuid

Account id of the member who created the workspace.

status*string

Workspace status (e.g. `active`).

Example: "active"

settings*object

Free-form workspace settings blob.

created_at*string · date-time

When the workspace was created.

updated_at*string · date-time

When the workspace was last changed.

Example

Request

PATCH https://api.platform-auth.productcraft.co/v1/workspaces/{workspace_slug}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "display_name": "Acme Corp",
  "slug": "acme",
  "settings": {}
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "slug": "acme-corp",
  "display_name": "Acme Corp",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "status": "active",
  "settings": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}