Function: deleteSettingsById()

deleteSettingsById<ThrowOnError>(options): RequestResult<DeleteSettingsByIdResponses, DeleteSettingsByIdErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:942

Permanently removes a specific system setting by its identifier. The DeleteSetting endpoint is used to decommission configuration parameters that are no longer required by the application. This operation is destructive and restricted to authorized personnel, ensuring that critical system settings are not removed accidentally. Upon success, the endpoint returns a 204 No Content status to signify the resource has been removed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteSettingsByIdData, ThrowOnError>

Returns

RequestResult<DeleteSettingsByIdResponses, DeleteSettingsByIdErrors, ThrowOnError>