PATCH /v1/me/settings

Family: Workspace account · Operation ID: v1_update_tenant_settings

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open workspace settings

Required scope: settings

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X PATCH "$API_BASE_URL/v1/me/settings" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

Request body · application/json

{
  "$ref": "#/components/schemas/UpdateTenantSettingsRequest",
  "definition": {
    "properties": {
      "approval_excellent_threshold": {
        "description": "Safe-to-send percentage for an excellent list. Set it with `approval_good_threshold`.",
        "format": "double",
        "nullable": true,
        "type": "number"
      },
      "approval_good_threshold": {
        "description": "Safe-to-send percentage for a good list. Must be below the excellent threshold.",
        "format": "double",
        "nullable": true,
        "type": "number"
      },
      "default_policy_mode": {
        "nullable": true,
        "type": "string"
      },
      "default_webhook_url": {
        "nullable": true,
        "type": "string"
      },
      "result_retention_days": {
        "format": "int32",
        "nullable": true,
        "type": "integer"
      },
      "webhook_signing_secret": {
        "nullable": true,
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TenantSettingsResponse"
      }
    }
  },
  "description": "Tenant settings updated"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract