Function: postSettings()

postSettings<ThrowOnError>(options?): RequestResult<PostSettingsResponses, PostSettingsErrors, ThrowOnError>

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

Creates a new system setting with a specified key and value. The PostSetting endpoint allows for the dynamic expansion of the system's configuration by defining new parameters. This endpoint validates that the provided setting does not already exist and that the requesting user has the necessary administrative rights to add new global configurations. Upon successful creation, the endpoint returns the newly established setting detail.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostSettingsData, ThrowOnError>

Returns

RequestResult<PostSettingsResponses, PostSettingsErrors, ThrowOnError>