Create a setting value

Módulo Settings

POST/setting-valuessettingValues.create

A setting value at one scope. The most specific scope wins unless a lock applies. Creates a setting value. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad org.general.write.
Alcances de OAuth: org.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: SettingValueCreate

settingValues.create: SettingValueCreate
Campo	Tipo	Obligatorio	Descripción
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	No	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.

{
  "scope_type": "Organization",
  "scope_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "setting_key": "finance.base_currency",
  "value": "USD"
}

Respuesta 201: SettingValue

settingValues.create: 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 POST "$XOS_BASE_URL/setting-values" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"scope_type":"Organization","scope_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","setting_key":"finance.base_currency","value":"USD"}'

const { data } = await xos.settingValues.create({
    "scope_type": "Organization",
    "scope_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "setting_key": "finance.base_currency",
    "value": "USD"
  });

response = xos.setting_values.create({"scope_type": "Organization", "scope_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "setting_key": "finance.base_currency", "value": "USD"})

xos setting-values create --data '{"scope_type":"Organization","scope_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","setting_key":"finance.base_currency","value":"USD"}'