---
title: "Set a platform-admin setting override"
method: PUT
path: "/api/v1/platform/settings/{key}"
tags: ["platform-settings"]
---

# Set a platform-admin setting override

`PUT /api/v1/platform/settings/{key}`

## Request

- Base URL: `https://api.helena.bio` (the document declares no server; this is the origin it was published from)
- URL: `https://api.helena.bio/api/v1/platform/settings/{key}`
- Auth: HTTP bearer

Set an override for a declared setting. Validates the value server-side
against the descriptor; an invalid value is REJECTED with 422 -- never
coerced (R6). On success the override row is UPSERTed and COMMITTED, THEN
the central AuditEvent is emitted (durable row before fail-open emit).

## Path parameters

- `key` string, required

## Request body

- UpdateSettingRequest
  - `value` unknown, required
  - `change_reason` string, nullable

## Response `200`

Successful Response

- SettingResponse
  - `key` string, required
  - `service` string, required
  - `config_path` string, required
  - `value_type` string, required
  - `default` unknown, required
  - `effective_value` unknown, required
  - `apply` string, required
  - `clinical_relevant` boolean, required
  - `label` string, required
  - `description` string, required
  - `minimum` number, nullable
  - `maximum` number, nullable
  - `allowed_values` unknown[], nullable
    - unknown
  - `is_overridden` boolean
  - `updated_by_user_id` string, nullable
  - `updated_by_user_name` string, nullable
  - `updated_by_user_email` string, nullable
  - `updated_at` string, nullable
  - `change_reason` string, nullable
  - `degrading_consequence` string, nullable
  - `degrading_target_value` boolean, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/helena/apis/helix-insight-variant-analysis-service.md) · [All operations](https://skmtc.dev/helena/apis/helix-insight-variant-analysis-service/llms.txt) · [OpenAPI document](https://skmtc.dev/helena/apis/helix-insight-variant-analysis-service/revisions/fe51fd20cdf1?raw)