Skip to content
AugentaDocsOpen console ↗
Update a Workspace

Documentation

API reference
View Markdown

Update a Workspace

PATCH/v1/workspaces/{id}

An administrator can change its name or synthesis cadence. null restores the platform cadence. Personal Default Workspaces cannot be renamed. Supply If-Match to protect against concurrent edits.

Authentication

Use your signed-in console session or a person's WorkOS access token for this setup operation. See authentication and permissions.

Request

Parameters

idstringrequired

path parameter.

Min length: 1

If-Matchstringoptional

header parameter.

Body fields

namestringoptional

Min length: 1Max length: 120

synthesisCadencestring | nulloptional

Allowed: "hourly""daily""weekly""monthly""manual"null

_etagstringoptional

Responses

The updated Workspace resource.

objectstringalways present

The resource type. Always workspace.

Allowed: "workspace"

idstringalways present

Workspace identity used in routes and memory selectors.

Min length: 1

orgIdstringalways present

Owning Organization's Augenta ID.

Min length: 1

namestringalways present

Display name. Renaming does not change the Workspace ID.

statusstringalways present

Current Workspace lifecycle state.

kindstringalways present

Shared Workspace or provisioned personal Default Workspace. Personal Workspaces have separate lifecycle rules.

ownerUserIdstringconditional

Owner of a personal Workspace, when applicable.

synthesisCadencestringconditional

Configured consolidation cadence, when set.

createdByUserIdstringalways present

Person who created the Workspace.

createdAtstringalways present

Recorded Workspace creation time.

updatedAtstringalways present

Recorded Workspace configuration update time.

_etagstringconditional

Revision for an If-Match update or archive, when available.

workspaceRolestringconditional

The signed-in person's effective Workspace role, when loaded.

viastringconditional

Source of effective access, such as direct or inherited membership, when loaded.

membersobjectconditional

Initial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.

Show nested fields
objectstringalways present

Allowed: "list"

urlstringalways present
dataarrayalways present
Show item fields
objectstringalways present

Allowed: "organization_member""workspace_member"

idstringalways present

Min length: 1

userIdstringalways present

Min length: 1

organizationstringalways present
workspacestringconditional
namestringconditional
emailstringconditional
rolestringconditional
workspaceRolestringconditional
orgRolestringconditional
viastringconditional
addedAtstringconditional
addedByUserIdstringconditional
permissionsarrayconditional
Show item fields
memberClassstringconditional
hasSignedInbooleanconditional
joinedAtstringconditional
nextPageUrlstring | nullalways present