PUT /settings
Update an existing system setting
/settings
PUT
Update an existing system setting
| Key | Type | Example | Description |
|---|---|---|---|
| authorization required | string |
"Bearer access_token"
|
Access token
|
| Key | Type | Example | Description |
|---|---|---|---|
| label required | string |
"example-string"
|
|
| value required | string |
"example-value"
|
|
| description optional | string |
"example-string"
|
|
| is_secure optional | boolean |
true
|
{
"label": "example-string",
"value": "example-string",
"is_secure": true,
"description": "example-string"
}
{
"error": "INVALID_ACCESS_TOKEN",
"code": 401
}
| Status | Error Code | Description |
|---|---|---|
401 |
INVALID_ACCESS_TOKEN |
Authentication required or invalid token |
403 |
INSUFFICIENT_PERMISSIONS |
Insufficient permissions for this operation |
| Permission | Description |
|---|---|
Bearer token |
Access token required via Authorization header, x-authtoken, x-token, query param, or cookie |
system_key_value_update |
Required scope: system_key_value_update |
setting_system_settings |
Additional permission check: setting_system_settings |
Back to Settings Return to the Settings category to view other endpoints All API Categories Browse all available API categories