Update system settings

Each group of system settings has its own permission for updating.

CODE

access-rights - system-settings-access-rights-update
links - system-settings-links-update

PATCH /api/admin/v1/system-settings/{setting}

Method parameters

int setting, unique identifier of the system setting

int|array value, setting value | Setting object (for permissions) | To clear a link-type setting, send the value as null or send the field itself | For captcha, the value is mandatory

bool is_enabled, only required for settings with the type link and configuration. It is not possible to enable a link if it is not specified. Disabling it without providing the value parameter and without a current value will result in a 422 error

200 OK

Successful response

JSON

{
    "id": 14,
    "description": "Description",
    "value": 1,
    "created_at": "2022-10-04T11:14:26.000000Z",
    "updated_at": "2022-10-06T10:11:58.000000Z",
    "type": null,
    "min": 1,
    "max": 100,
    "cast_type": "integer",
    "is_enabled": null
}

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

403 Forbidden

If there are no access rights to get a group of settings

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/system-settings/{setting}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "setting": 0,
    "value": "int|array",
    "is_enabled": true
}'

PHP

$data = array (
  'setting' => 0,
  'value' => 'int|array',
  'is_enabled' => true,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'PATCH',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/system-settings/{setting}', false, $context);