Skip to main content
PATCH
Rename the workspace or change its slug

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Body

application/json
name
string

Trimmed. No control characters.

Required string length: 1 - 80
slug
string

Lowercase letters, digits and hyphens. Not one of the Worker's reserved first path segments (api, admin, next, brand, portal, mcp, cli, ...), and not another workspace's slug or former slug.

Required string length: 3 - 48
Pattern: ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

Response

Saved (or nothing changed). The workspace as it now is.

id
string
required
name
string
required
slug
string
required

The first path segment of every public endpoint URL: /{workspace}/{project}/{endpoint}.

aliases
object[]
required

Former slugs, newest first. Path-form ingest still accepts each one, permanently, so a URL a provider already holds keeps working. No other workspace can take them.

ok
enum<boolean>
required
Available options:
true