Skip to main content
PATCH
Change the workspace

Authorizations

Authorization
string
header
required

An API key (zode_tok_...). Create one in the console under API keys (https://console.zode.dev/tokens), or with zode login.

Body

application/json
name
string
Pattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
display_name
string

Trimmed.

Required string length: 1 - 64
billing_email
string

"" clears it.

browser_default
boolean

402 plan_required when the plan does not include it.

desktop_default
boolean

402 plan_required when the plan does not include it.

Response

Updated workspace

id
string
required
name
string
required

Unique slug (CLI).

display_name
string
required
plan
enum<string>
required
Available options:
free,
pro,
team,
enterprise
personal
boolean
required
billing_email
string | null
required
created_at
string<date-time>
required
role
enum<string>
required

The caller's role.

Available options:
owner,
admin,
billing,
member
member_count
integer
required
browser_default
boolean

New sandboxes get the browser.

desktop_default
boolean

New sandboxes get the desktop.

plan_allows
object