PUT /settings

Update an existing system setting

Update an existing system setting
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
KeyTypeExampleDescription
descriptionoptionalstring
"example-string"
is_secureoptionalboolean
true
labelrequiredstring
"example-string"
valuerequiredstring
"example-value"
{
  "description": "example-string",
  "is_secure": true,
  "label": "example-string",
  "value": "example-string"
}
{
  "code": 401,
  "error": "INVALID_ACCESS_TOKEN"
}
StatusError CodeDescription
401INVALID_ACCESS_TOKENAuthentication required or invalid token
403INSUFFICIENT_PERMISSIONSInsufficient permissions for this operation
PermissionDescription
Bearer tokenAccess token required via Authorization header, x-authtoken, x-token, query param, or cookie
system_key_value_updateRequired scope: system_key_value_update
setting_system_settingsAdditional 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