POST api/moduleSettings

Creates a module setting.

Request Information

URI Parameters

None.

Body Parameters

The module setting model to create with.

Name	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": "03bd7dfa-8607-49a9-9eaf-96f71af51b23",
  "Name": "sample string 2",
  "Url": "sample string 3",
  "DisplayName": "sample string 4",
  "ServiceType": 0,
  "CreationDate": "2026-01-11T20:54:51.5473424+00:00",
  "TenantId": "0212f4e2-8a44-41d0-b415-83a8b2c4b555",
  "UserJourneyId": "dc7600b6-ff8d-4522-9693-4ee0d6d144c5",
  "Bypassable": true,
  "DefaultValue": "sample string 9",
  "SortIndex": 10,
  "ModuleSettingProperties": [
    {
      "Id": "4f1007ff-8309-4fd0-b8ea-44807866bb1f",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-11T20:54:51.5492297+00:00",
      "ModuleSettingId": "6f7b0821-0315-4e9e-b412-8b3281289fcf"
    },
    {
      "Id": "4f1007ff-8309-4fd0-b8ea-44807866bb1f",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-11T20:54:51.5492297+00:00",
      "ModuleSettingId": "6f7b0821-0315-4e9e-b412-8b3281289fcf"
    }
  ]
}

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:54:51.5473424+00:00</CreationDate>
  <DefaultValue>sample string 9</DefaultValue>
  <DisplayName>sample string 4</DisplayName>
  <Id>03bd7dfa-8607-49a9-9eaf-96f71af51b23</Id>
  <ModuleSettingProperties>
    <ModuleSettingPropertyDto>
      <CreationDate>2026-01-11T20:54:51.5492297+00:00</CreationDate>
      <Id>4f1007ff-8309-4fd0-b8ea-44807866bb1f</Id>
      <ModuleSettingId>6f7b0821-0315-4e9e-b412-8b3281289fcf</ModuleSettingId>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </ModuleSettingPropertyDto>
    <ModuleSettingPropertyDto>
      <CreationDate>2026-01-11T20:54:51.5492297+00:00</CreationDate>
      <Id>4f1007ff-8309-4fd0-b8ea-44807866bb1f</Id>
      <ModuleSettingId>6f7b0821-0315-4e9e-b412-8b3281289fcf</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>0212f4e2-8a44-41d0-b415-83a8b2c4b555</TenantId>
  <Url>sample string 3</Url>
  <UserJourneyId>dc7600b6-ff8d-4522-9693-4ee0d6d144c5</UserJourneyId>
</ModuleSettingDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"844ad8c6-c4bb-4fc7-a370-fc1ef3801353"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">844ad8c6-c4bb-4fc7-a370-fc1ef3801353</guid>