Creates a new 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": "e5564a8b-a46f-4c20-9a5c-71f038222f4b",
"code": "sample string 2",
"value": "sample string 3",
"sales_organization_id": "8028403f-c36a-4bd0-8a99-9d2d179727f0",
"user_id": "0f396932-f19d-4d02-9d5f-498a9b5877c1",
"modified_dateutc": "2026-11-12T14:27:53.2281481+00:00"
}
application/xml, text/xml
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <code>sample string 2</code> <id>e5564a8b-a46f-4c20-9a5c-71f038222f4b</id> <modified_dateutc>2026-11-12T14:27:53.228Z</modified_dateutc> <sales_organization_id>8028403f-c36a-4bd0-8a99-9d2d179727f0</sales_organization_id> <user_id>0f396932-f19d-4d02-9d5f-498a9b5877c1</user_id> <value>sample string 3</value> </settings>
Response Information
Resource Description :
IHttpActionResult containing the created 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": "9378cd3b-da91-406e-af80-249aee0ebb77",
"code": "sample string 2",
"value": "sample string 3",
"sales_organization_id": "e8b807f3-59a9-45ae-87b7-bf3723ff95e9",
"user_id": "d82decf3-5782-4282-97ab-b06e6ae5face",
"modified_dateutc": "2026-11-12T14:27:53.2281481+00:00"
}
application/xml, text/xml
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <code>sample string 2</code> <id>9378cd3b-da91-406e-af80-249aee0ebb77</id> <modified_dateutc>2026-11-12T14:27:53.228Z</modified_dateutc> <sales_organization_id>e8b807f3-59a9-45ae-87b7-bf3723ff95e9</sales_organization_id> <user_id>d82decf3-5782-4282-97ab-b06e6ae5face</user_id> <value>sample string 3</value> </settings>