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": "5b363647-d493-45ed-9759-63f4061e9073",
"code": "sample string 2",
"value": "sample string 3",
"sales_organization_id": "5fc7ceea-8eef-4ae9-ae14-3125ee4e162b",
"user_id": "87d51f5a-050f-41f0-9205-f275451c3a43",
"modified_dateutc": "2026-11-12T14:28:08.4627649+00:00"
}
application/xml, text/xml
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <code>sample string 2</code> <id>5b363647-d493-45ed-9759-63f4061e9073</id> <modified_dateutc>2026-11-12T14:28:08.462Z</modified_dateutc> <sales_organization_id>5fc7ceea-8eef-4ae9-ae14-3125ee4e162b</sales_organization_id> <user_id>87d51f5a-050f-41f0-9205-f275451c3a43</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": "2b998c78-8c1a-4891-84fa-6ce706f6d43b",
"code": "sample string 2",
"value": "sample string 3",
"sales_organization_id": "a3cfbdfb-0c8f-4fc9-96fe-e72b7bcd9577",
"user_id": "dcd4bd4c-957d-449a-a1c1-31935af96284",
"modified_dateutc": "2026-11-12T14:28:08.4627649+00:00"
}
application/xml, text/xml
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <code>sample string 2</code> <id>2b998c78-8c1a-4891-84fa-6ce706f6d43b</id> <modified_dateutc>2026-11-12T14:28:08.462Z</modified_dateutc> <sales_organization_id>a3cfbdfb-0c8f-4fc9-96fe-e72b7bcd9577</sales_organization_id> <user_id>dcd4bd4c-957d-449a-a1c1-31935af96284</user_id> <value>sample string 3</value> </settings>