Rename, change the URL, or restore a Workspace
Rename, change the URL, or restore a Workspace
/api/v1/workspaces/{workspace_id}Changes exactly one of name, slug, or archived. Renaming and URL
changes require the workspace:manage capability; archived: false
restores an archived Workspace and is the only mutation an archived
Workspace accepts.
archived: true is rejected here — archiving is
DELETE /api/v1/workspaces/{workspace_id}, which additionally
requires an owner and recent authentication.
slug is the canonical Workspace URL segment. It must be unique and
use lowercase letters, numbers, and interior hyphens only.
Path Parameters
Header Parameters
string·min 43·max 43Session-bound CSRF token. It must exactly match the
__Host-assign_csrf cookie sent with the request.
Request Body
application/jsonResponses
stringQuoted decimal optimistic-concurrency version.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
stringServer-generated canonical Workspace URL segment. Authorized Workspace managers can change it through the revisioned Workspace update operation.
string <date-time>When set, the Workspace is archived: no data was deleted, every session scoped to it was revoked, and its scoped routes answer not-found for everyone but an owner.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
integer·min 1Seconds until the client may retry.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.