Skip to main content
Update Workspace
Edits a workspace’s own name and/or metadata. Gated by the edit-workspace capability (or owner).
This does not flip inheritsFromParent — that is a separate owner-only action.

Path Parameters

string
required
The workspace UUID.

Body Parameters

string
New display name. 1–100 characters.
object
New metadata (opaque JSON).
string
required
Service keys only — the user to act as. Required with a service key: a key that names nobody is refused with 400 workspace/missing-user-id. Enforced: the edit-workspace capability (or ownership) is required of the named user, so a key naming someone without it is refused exactly as that user would be. A user token always acts as its own user and must not send it (400 workspace/acting-user-not-allowed). See Acting on behalf of a user.Several shapes are refused rather than ignored on this path. actingUserId: "" or null is a 400 — it reads as an attempt to name someone, not as “nobody”. So is every top-level body field this endpoint does not declare, for every caller: onBehalfOf, acting_user_id and impersonate all come back as Unrecognized key: "…" rather than being quietly dropped. A key that differs from actingUserId only in capitalization — actingUserID, actinguserid — is refused too, but with a “did you mean actingUserId?” message instead of the generic one. And when the request names nobody, so is any body whose Content-Type is not application/json — an unparsed body discards the actingUserId inside it just as surely as a misspelling would. In the query string, actingUserId and every body field are 400 workspace/wrong-location. See Shapes the server rejects.

Response

Returns the updated Workspace object.

Error Responses

Every path id on the workspaces bundle is checked for UUID shape before the route runs, so a malformed one is a plain 400 rather than a 500 from the database.
Every workspaces endpoint declares its body fields exactly, and a top-level body field it does not declare is refused rather than ignored, for every caller. Two or more at once are named together: Unrecognized keys: "onBehalfOf", "impersonate". Send only the fields documented above, in the JSON body. The query string carries none of them: a body field sent there is 400 workspace/wrong-location, a userId or a re-cased actingUserId there is 400 workspace/invalid-query, and any other query parameter is ignored. See Shapes the server rejects.
Returned when a service key sends a body with a Content-Type other than application/json and no actingUserId was read. Sublay parses only application/json, so the actor inside such a body is discarded and the request would name no acting user. fetch() sends text/plain;charset=UTF-8 when you pass a stringified body and set no headers — set the header. An empty JSON body and a bodiless request both pass. See Shapes the server rejects.
A service key sent no actingUserId. The request has to act as somebody, and is held to exactly that user’s standing on the workspace.
A user token sent actingUserId, even naming its own user. Only a service key names the user it acts as; a user token always acts as its own user.
A field this endpoint reads from the body was sent in the query string. actingUserId and every body field go in the JSON body.
Returned when a service key names an actingUserId that isn’t a user in this project.