/v1/workspaces/{workspace_slug}AuthUpdate workspace display name, slug, or settings. Slug renames broadcast a `workspace.renamed` event so denormalised consumers (waitlist-api) sync.
Path parameters
workspace_slug*stringSlug 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_namestringNew display name of the workspace.
Example: "Acme Corp"
slugstringNew 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"
settingsobjectFree-form workspace settings blob.
Response · 200 Workspace updated.
id*string · uuidId of the workspace.
slug*stringUnique URL-friendly slug; platform routes take it positionally.
Example: "acme-corp"
display_name*stringDisplay name of the workspace.
Example: "Acme Corp"
created_by*string · uuidAccount id of the member who created the workspace.
status*stringWorkspace status (e.g. `active`).
Example: "active"
settings*objectFree-form workspace settings blob.
created_at*string · date-timeWhen the workspace was created.
updated_at*string · date-timeWhen 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"
}