Skip to content
XOS Developers

Delete a setting value

Settings module

DELETE/setting-values/{id}settingValues.delete

A setting value at one scope. The most specific scope wins unless a lock applies. Soft-deletes the setting value: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.general.write.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

settingValues.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the setting value.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/setting-values/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.settingValues.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.setting_values.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos setting-values delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f