PUT v1/systemsettings/{key}

Updates the value of a system setting.

Request Information

URI Parameters

Name	Description	Type	Additional information
key	The key that identifies the system setting	string	Required

Body Parameters

The updated information

SystemSetting

Name	Description	Type	Additional information
Id	A unique ID for the object.	integer	Read-only.
Name	Name of the setting	string	Read-only.
Key	A unique key of the setting	string	Read-only.
Value	Value of the setting	string	None.
CreatedDate	Time and date the object was created.	date	Read-only.
ArchivedDate	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.
ReadOnly	Whether or not the system setting can be edited	boolean	None.
Type	The value type of the setting.	string	None.
Operations		Collection of OperationResult	None.

Request Formats

Response Information

Resource Description

The updated system setting

SystemSetting

Name	Description	Type	Additional information
Id	A unique ID for the object.	integer	Read-only.
Name	Name of the setting	string	Read-only.
Key	A unique key of the setting	string	Read-only.
Value	Value of the setting	string	None.
CreatedDate	Time and date the object was created.	date	Read-only.
ArchivedDate	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.
ReadOnly	Whether or not the system setting can be edited	boolean	None.
Type	The value type of the setting.	string	None.
Operations		Collection of OperationResult	None.

Response Formats