Update a setting value

Módulo Settings

PATCH/setting-values/{id}settingValues.update

A setting value at one scope. The most specific scope wins unless a lock applies. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requiere la capacidad org.general.write.
Alcances de OAuth: org.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

settingValues.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the setting value.

Cuerpo de la solicitud: SettingValueUpdate

settingValues.update: SettingValueUpdate
Campo	Tipo	Obligatorio	Descripción
value	string \| number \| boolean	No	Typed value.

{
  "value": "USD"
}

Respuesta 200: SettingValue

settingValues.update: SettingValue
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the setting value.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
scope_type	SettingScope	Sí	Scope a setting value applies to, most specific first (Section 4.5.6).Restricciones: one of "Personal", "Project", "Team", "Workspace", "Organization", "Platform"
scope_id	string (uuid) \| null	Sí	Identifier of the scope row.
setting_key	string	Sí	Setting key.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
value	string \| number \| boolean	Sí	Typed value.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_type": "Organization",
  "scope_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "setting_key": "finance.base_currency",
  "value": "USD"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/setting-values/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"value":"USD"}'

const { data, etag } = await xos.settingValues.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "value": "USD"
  }, { ifMatch: etag });

response = xos.setting_values.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"value": "USD"}, if_match=etag)

xos setting-values update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"value":"USD"}' --if-match auto