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
`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.
`ReadOnly`	Whether or not the system setting can be edited	boolean	None.
`Type`	The value type of the setting.	string	None.
`Id`	A unique ID for the object.	integer	Read-only.
`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.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<SystemSetting xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>6</Id>
  <CreatedDate>2024-09-14T19:17:31.595397+02:00</CreatedDate>
  <ArchivedDate>2024-09-14T19:17:31.595397+02:00</ArchivedDate>
  <Name>sample string 1</Name>
  <Key>sample string 2</Key>
  <Value>sample string 3</Value>
  <ReadOnly>true</ReadOnly>
  <Type>sample string 5</Type>
</SystemSetting>

Response Information

Resource Description

The updated system setting

SystemSetting

Name	Description	Type	Additional information
`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.
`ReadOnly`	Whether or not the system setting can be edited	boolean	None.
`Type`	The value type of the setting.	string	None.
`Id`	A unique ID for the object.	integer	Read-only.
`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.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<SystemSetting xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>6</Id>
  <CreatedDate>2024-09-14T19:17:31.595397+02:00</CreatedDate>
  <ArchivedDate>2024-09-14T19:17:31.595397+02:00</ArchivedDate>
  <Name>sample string 1</Name>
  <Key>sample string 2</Key>
  <Value>sample string 3</Value>
  <ReadOnly>true</ReadOnly>
  <Type>sample string 5</Type>
</SystemSetting>