POST/v1/configProperty

Updates a config property

Requires permission SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields
groupNamestringrequired
Group the property belongs to
propertyNamestringrequired
Name of the property
propertyValuestringoptional
Value of the property

3 status codes
200The updated config property
descriptionstringoptional
Description of the property
groupNamestringrequired
Group the property belongs to
propertyNamestringrequired
Name of the property
propertyTypestringrequired
Type of the property
Allowed:BOOLEANINTEGERNUMBERSTRINGTIMESTAMPURLUUID
propertyValuestringoptional
Value of the property
401Unauthorized
404The config property could not be found

Error handling

A 401 is returned: Unauthorized. A 404 is returned: The config property could not be found.