Skip to main content
PATCH
Update workspace settings
Related guide: Workspace settings guide. See the Workspace settings guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

UpdateWorkspaceSettingsRequest is a partial update: every field is optional and an omitted field is left unchanged.

There is deliberately no key / slug field. The workspace slug is immutable through this service (it is embedded in resource URLs and API credentials), mirroring the dashboard's WorkspaceUpdateGuard, which rejects a key in the PATCH /workspaces/:key body. Do not add one.

display_name
string

New workspace display name. Omit to keep the current name.

enforce_enabled_models
boolean

New value for the enforce-enabled-models flag. Omit to keep the current value.

pii_redaction
object

Replacement workspace-default PII redaction configuration. Omit to leave the current PII redaction configuration unchanged; when present it fully replaces the stored pii_redaction object.

Response

200 - application/json

OK

settings
object
required

Updated workspace settings.