---
title: "Update workspace settings"
method: PATCH
path: "/v2/workspace-settings"
tags: ["Workspace Settings"]
---

# Update workspace settings

`PATCH /v2/workspace-settings`

Partially updates workspace settings. Every field is optional; an omitted field is left unchanged. Provide `display_name` to rename the workspace, `enforce_enabled_models` to toggle model enforcement, or `pii_redaction` to replace the workspace-default PII redaction plugin configuration.

## Request body

- UpdateWorkspaceSettingsRequest — 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` PiiRedaction — PiiRedaction is the workspace-default configuration for the pii_redaction plugin: an enable flag plus the optional plugin config the gateway applies as a floor for requests that send no plugins of their own.
    - `enabled` boolean, required — Whether the workspace-default PII redaction plugin is enabled.
    - `config` PiiRedactionConfig — PiiRedactionConfig mirrors the workspace-default PII redaction plugin config (libs/go/models PIIRedactionPlugin / libs/models/gateway PIIRedactionPluginSchema). Every field is optional; the gateway applies its own defaults for unset fields. The stored value is validated on write with the same models.PIIRedactionPlugin.Validate() the gateway runs per request. Without that, an invalid workspace default would 400 every gateway call for the workspace, since the default plugin is injected into each request and validated there.
      - `language` string — Detector language. One of "en" or "nl"; omit for the gateway default ("en"). The valid entity catalog depends on this value.
      - `entities` string[] — Entity types to redact (e.g. "EMAIL_ADDRESS", "PERSON"). Values are validated against the entity catalog for `language`; omit to redact every type the detector finds.
      - `on_failure` string — Behaviour when redaction cannot run: "block" (fail closed, the default) or "passthrough" (fail open, send the original text).
      - `threshold` number, double — Detection confidence threshold in the [0, 1] range.

## Response `200`

OK

- UpdateWorkspaceSettingsResponse
  - `settings` WorkspaceSettings, required — WorkspaceSettings is the full settings state returned by Get and Update.
    - `key` string, required — Read-only workspace key/slug. Returned for reference; it cannot be changed through this service.
    - `display_name` string, required — Human-readable workspace display name.
    - `enforce_enabled_models` boolean, required — Whether only workspace-enabled models may be served.
    - `pii_redaction` PiiRedaction — PiiRedaction is the workspace-default configuration for the pii_redaction plugin: an enable flag plus the optional plugin config the gateway applies as a floor for requests that send no plugins of their own.
      - `enabled` boolean, required — Whether the workspace-default PII redaction plugin is enabled.
      - `config` PiiRedactionConfig — PiiRedactionConfig mirrors the workspace-default PII redaction plugin config (libs/go/models PIIRedactionPlugin / libs/models/gateway PIIRedactionPluginSchema). Every field is optional; the gateway applies its own defaults for unset fields. The stored value is validated on write with the same models.PIIRedactionPlugin.Validate() the gateway runs per request. Without that, an invalid workspace default would 400 every gateway call for the workspace, since the default plugin is injected into each request and validated there.
        - `language` string — Detector language. One of "en" or "nl"; omit for the gateway default ("en"). The valid entity catalog depends on this value.
        - `entities` string[] — Entity types to redact (e.g. "EMAIL_ADDRESS", "PERSON"). Values are validated against the entity catalog for `language`; omit to redact every type the detector finds.
        - `on_failure` string — Behaviour when redaction cannot run: "block" (fail closed, the default) or "passthrough" (fail open, send the original text).
        - `threshold` number, double — Detection confidence threshold in the [0, 1] range.

---

[API](https://skmtc.net/orq-ai/apis/orq-ai-api.md) · [All operations](https://skmtc.net/orq-ai/apis/orq-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/orq-ai/orq-ai-api/versions/41c02aedc7c0/schema)