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": "1474aa59-0df6-4c78-84d9-fe774481307a",
"Name": "sample string 2",
"Url": "sample string 3",
"DisplayName": "sample string 4",
"ServiceType": 0,
"CreationDate": "2025-12-06T04:53:10.6108432+00:00",
"TenantId": "d75603b3-897d-4584-9fee-a8dc58f89de2",
"UserJourneyId": "61fde6da-cfce-441d-ae5b-7aae788be1a4",
"Bypassable": true,
"DefaultValue": "sample string 9",
"SortIndex": 10,
"ModuleSettingProperties": [
{
"Id": "6f8e3a7d-73f8-4ced-9b3b-9aedbdc96d08",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2025-12-06T04:53:10.6108432+00:00",
"ModuleSettingId": "984d91ce-72f0-4e7a-b7c4-0699ac1e9ffa"
},
{
"Id": "6f8e3a7d-73f8-4ced-9b3b-9aedbdc96d08",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2025-12-06T04:53:10.6108432+00:00",
"ModuleSettingId": "984d91ce-72f0-4e7a-b7c4-0699ac1e9ffa"
}
]
}
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>2025-12-06T04:53:10.6108432+00:00</CreationDate>
<DefaultValue>sample string 9</DefaultValue>
<DisplayName>sample string 4</DisplayName>
<Id>1474aa59-0df6-4c78-84d9-fe774481307a</Id>
<ModuleSettingProperties>
<ModuleSettingPropertyDto>
<CreationDate>2025-12-06T04:53:10.6108432+00:00</CreationDate>
<Id>6f8e3a7d-73f8-4ced-9b3b-9aedbdc96d08</Id>
<ModuleSettingId>984d91ce-72f0-4e7a-b7c4-0699ac1e9ffa</ModuleSettingId>
<Name>sample string 2</Name>
<Value>sample string 3</Value>
</ModuleSettingPropertyDto>
<ModuleSettingPropertyDto>
<CreationDate>2025-12-06T04:53:10.6108432+00:00</CreationDate>
<Id>6f8e3a7d-73f8-4ced-9b3b-9aedbdc96d08</Id>
<ModuleSettingId>984d91ce-72f0-4e7a-b7c4-0699ac1e9ffa</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>d75603b3-897d-4584-9fee-a8dc58f89de2</TenantId>
<Url>sample string 3</Url>
<UserJourneyId>61fde6da-cfce-441d-ae5b-7aae788be1a4</UserJourneyId>
</ModuleSettingDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.