Function: putSettingsById()

putSettingsById<ThrowOnError>(options): RequestResult<PutSettingsByIdResponses, PutSettingsByIdErrors, ThrowOnError>

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

Updates the value of an existing system setting. The PutSetting endpoint is designed for straightforward value replacements, allowing administrators to reconfigure existing keys with new data. This operation ensures that the setting exists and that the update is performed within the bounds of the user's permissions, returning a 204 No Content status upon a successful modification of the configuration value.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PutSettingsByIdData, ThrowOnError>

Returns

RequestResult<PutSettingsByIdResponses, PutSettingsByIdErrors, ThrowOnError>