Function: patchSettingsById()

patchSettingsById<ThrowOnError>(options): RequestResult<PatchSettingsByIdResponses, PatchSettingsByIdErrors, ThrowOnError>

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

Partially updates a specific system setting using a JSON Patch document. The PatchSetting endpoint enables granular modifications to a setting's properties, allowing administrators to change only specific fields without overwriting the entire resource. This is ideal for adjusting metadata or performing surgical updates to configuration values while ensuring all changes are validated and authorized.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchSettingsByIdData, ThrowOnError>

Returns

RequestResult<PatchSettingsByIdResponses, PatchSettingsByIdErrors, ThrowOnError>