Updates the setting with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The setting id.

 globally unique identifier

Required

Body Parameters :

settings
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
code

Key/name identifying which setting this record holds the value for.

 string
value

Value of the setting identified by , stored as text.

 string
sales_organization_id

Foreign key of the sales organization this setting applies to.

 globally unique identifier
user_id

Foreign key of the user this setting applies to, when scoped to an individual user rather than the whole organization.

 globally unique identifier
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Request Formats :

application/json, text/json

Sample: 
{
  "id": "b454800a-7061-4c81-8b6e-d23f142a802b",
  "code": "sample string 2",
  "value": "sample string 3",
  "sales_organization_id": "6f82c62c-df3c-4f8b-8394-3c982d3b1367",
  "user_id": "6158355a-359d-4fb9-bf70-f982b8c9232f",
  "modified_dateutc": "2026-09-16T11:04:58.5254801+00:00"
}

application/xml, text/xml

Sample: 
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <code>sample string 2</code>
  <id>b454800a-7061-4c81-8b6e-d23f142a802b</id>
  <modified_dateutc>2026-09-16T11:04:58.525Z</modified_dateutc>
  <sales_organization_id>6f82c62c-df3c-4f8b-8394-3c982d3b1367</sales_organization_id>
  <user_id>6158355a-359d-4fb9-bf70-f982b8c9232f</user_id>
  <value>sample string 3</value>
</settings>

Response Information

Resource Description :

IHttpActionResult containing the updated setting.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.