PUT api/moduleSettings/{id}
Updates a module setting.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the module setting to update. |
globally unique identifier |
Required |
Body Parameters
The module setting model to update with.
ModuleSettingDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
Required |
|
| Url | string |
Required |
|
| DisplayName | string |
Required |
|
| ServiceType | ModuleSettingServiceTypeDto |
None. |
|
| CreationDate | date |
None. |
|
| TenantId | globally unique identifier |
None. |
|
| UserJourneyId | globally unique identifier |
None. |
|
| Bypassable | boolean |
None. |
|
| DefaultValue | string |
None. |
|
| SortIndex | integer |
None. |
|
| ModuleSettingProperties | Collection of ModuleSettingPropertyDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "3b095f34-b74d-4a07-b495-9ac94a5f6274",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2026-01-11T20:58:00.4724194+00:00",
"TenantId": "d99b1423-5aef-4882-9a74-3d05f1263d54",
"UserJourneyId": "f757cd21-c967-49cc-b362-94bb99c5788b",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "538d7a2c-9e89-4790-9032-733f8d961d15",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:58:00.4724194+00:00",
"ModuleSettingId": "50f21916-97ea-4ab3-b86d-ef1a474bed26"
},
{
"Id": "538d7a2c-9e89-4790-9032-733f8d961d15",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-11T20:58:00.4724194+00:00",
"ModuleSettingId": "50f21916-97ea-4ab3-b86d-ef1a474bed26"
}
]
}
application/xml, text/xml
Sample:
<ModuleSettingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models">
<Bypassable>true</Bypassable>
<CreationDate>2026-01-11T20:58:00.4724194+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>3b095f34-b74d-4a07-b495-9ac94a5f6274</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:58:00.4724194+00:00</CreationDate>
<Id>538d7a2c-9e89-4790-9032-733f8d961d15</Id>
<ModuleSettingId>50f21916-97ea-4ab3-b86d-ef1a474bed26</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2026-01-11T20:58:00.4724194+00:00</CreationDate>
<Id>538d7a2c-9e89-4790-9032-733f8d961d15</Id>
<ModuleSettingId>50f21916-97ea-4ab3-b86d-ef1a474bed26</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
</ModuleSettingProperties>
<Name>sample string 2</Name>
<ServiceType>None</ServiceType>
<SortIndex>10</SortIndex>
<TenantId>d99b1423-5aef-4882-9a74-3d05f1263d54</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>f757cd21-c967-49cc-b362-94bb99c5788b</UserJourneyId>
</ModuleSettingDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.