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": "cb6370b2-f245-498d-8b52-bf7348e0e704",
  "code": "sample string 2",
  "value": "sample string 3",
  "sales_organization_id": "4c621ae1-837a-4fa7-bbb3-7ce791671800",
  "user_id": "b9ef17a5-bd0d-4bd7-9fc6-79f9c805c043",
  "modified_dateutc": "2026-11-12T14:28:47.4477396+00:00"
}

application/xml, text/xml

Sample: 
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <code>sample string 2</code>
  <id>cb6370b2-f245-498d-8b52-bf7348e0e704</id>
  <modified_dateutc>2026-11-12T14:28:47.447Z</modified_dateutc>
  <sales_organization_id>4c621ae1-837a-4fa7-bbb3-7ce791671800</sales_organization_id>
  <user_id>b9ef17a5-bd0d-4bd7-9fc6-79f9c805c043</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.