Creates or updates a setting.
Request Information
URI Parameters :
None.
Body Parameters :
settings| Name | Description | Type | Additional 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
{
"id": "74d0db6e-1105-43c5-ac66-f636aaba471d",
"code": "sample string 2",
"value": "sample string 3",
"sales_organization_id": "599e5235-1401-480e-a4da-92702612bd10",
"user_id": "4aa4fe21-8a2c-49bc-93c3-63200f7a0381",
"modified_dateutc": "2026-09-16T10:14:03.2047534+00:00"
}
application/xml, text/xml
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <code>sample string 2</code> <id>74d0db6e-1105-43c5-ac66-f636aaba471d</id> <modified_dateutc>2026-09-16T10:14:03.204Z</modified_dateutc> <sales_organization_id>599e5235-1401-480e-a4da-92702612bd10</sales_organization_id> <user_id>4aa4fe21-8a2c-49bc-93c3-63200f7a0381</user_id> <value>sample string 3</value> </settings>
Response Information
Resource Description :
IHttpActionResult containing the saved setting.
settings| Name | Description | Type | Additional 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 |
Response Formats
application/json, text/json
{
"id": "08935ca3-5d39-425c-9a02-2b59c40b9eae",
"code": "sample string 2",
"value": "sample string 3",
"sales_organization_id": "6fc770c5-e9a8-4981-95b6-41a6037cda21",
"user_id": "f9e66df7-5ffc-4218-8496-dd2801b2300a",
"modified_dateutc": "2026-09-16T10:14:03.2226327+00:00"
}
application/xml, text/xml
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <code>sample string 2</code> <id>08935ca3-5d39-425c-9a02-2b59c40b9eae</id> <modified_dateutc>2026-09-16T10:14:03.222Z</modified_dateutc> <sales_organization_id>6fc770c5-e9a8-4981-95b6-41a6037cda21</sales_organization_id> <user_id>f9e66df7-5ffc-4218-8496-dd2801b2300a</user_id> <value>sample string 3</value> </settings>