POST api/userJourneys

Creates a user journey.

Request Information

URI Parameters

None.

Body Parameters

The user journey model to create with.

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	Required
DisplayName	string	Required
CreationDate	date	None.
TenantId	globally unique identifier	None.
Type	UserJourneyTypeDto	None.
SortIndex	integer	None.
UserJourneyProperties	Collection of UserJourneyPropertyDto	None.
ModuleSettings	Collection of ModuleSettingDto	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "e0ed419d-cebb-4ae5-89ce-3389e6de43b8",
  "Name": "sample string 2",
  "DisplayName": "sample string 3",
  "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
  "TenantId": "da9a6c4e-eccc-49a7-8f7c-9b12cecb5e0d",
  "Type": 0,
  "SortIndex": 6,
  "UserJourneyProperties": [
    {
      "Id": "b6153bb9-f304-4db4-8ac6-045f68616d6a",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
      "UserJourneyId": "8e335d62-7335-4cf5-a3de-88a219156afc"
    },
    {
      "Id": "b6153bb9-f304-4db4-8ac6-045f68616d6a",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
      "UserJourneyId": "8e335d62-7335-4cf5-a3de-88a219156afc"
    }
  ],
  "ModuleSettings": [
    {
      "Id": "fb266625-8763-4da2-92a3-481c6f2be7fd",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "DisplayName": "sample string 4",
      "ServiceType": 0,
      "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
      "TenantId": "32ba0096-4ab8-4e55-a8ef-f144567e8c09",
      "UserJourneyId": "e78e55ce-5a0b-48cb-b942-b16aac5b4199",
      "Bypassable": true,
      "DefaultValue": "sample string 9",
      "SortIndex": 10,
      "ModuleSettingProperties": [
        {
          "Id": "544e6bb1-23ea-4b6c-ba66-8e80986b0a22",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
          "ModuleSettingId": "df73c1d0-8929-4a7e-bcfc-075963101443"
        },
        {
          "Id": "544e6bb1-23ea-4b6c-ba66-8e80986b0a22",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
          "ModuleSettingId": "df73c1d0-8929-4a7e-bcfc-075963101443"
        }
      ]
    },
    {
      "Id": "fb266625-8763-4da2-92a3-481c6f2be7fd",
      "Name": "sample string 2",
      "Url": "sample string 3",
      "DisplayName": "sample string 4",
      "ServiceType": 0,
      "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
      "TenantId": "32ba0096-4ab8-4e55-a8ef-f144567e8c09",
      "UserJourneyId": "e78e55ce-5a0b-48cb-b942-b16aac5b4199",
      "Bypassable": true,
      "DefaultValue": "sample string 9",
      "SortIndex": 10,
      "ModuleSettingProperties": [
        {
          "Id": "544e6bb1-23ea-4b6c-ba66-8e80986b0a22",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
          "ModuleSettingId": "df73c1d0-8929-4a7e-bcfc-075963101443"
        },
        {
          "Id": "544e6bb1-23ea-4b6c-ba66-8e80986b0a22",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-06T03:11:38.5570457+00:00",
          "ModuleSettingId": "df73c1d0-8929-4a7e-bcfc-075963101443"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<UserJourneyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models">
  <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
  <DisplayName>sample string 3</DisplayName>
  <Id>e0ed419d-cebb-4ae5-89ce-3389e6de43b8</Id>
  <ModuleSettings>
    <ModuleSettingDto>
      <Bypassable>true</Bypassable>
      <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
      <DefaultValue>sample string 9</DefaultValue>
      <DisplayName>sample string 4</DisplayName>
      <Id>fb266625-8763-4da2-92a3-481c6f2be7fd</Id>
      <ModuleSettingProperties>
        <ModuleSettingPropertyDto>
          <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
          <Id>544e6bb1-23ea-4b6c-ba66-8e80986b0a22</Id>
          <ModuleSettingId>df73c1d0-8929-4a7e-bcfc-075963101443</ModuleSettingId>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </ModuleSettingPropertyDto>
        <ModuleSettingPropertyDto>
          <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
          <Id>544e6bb1-23ea-4b6c-ba66-8e80986b0a22</Id>
          <ModuleSettingId>df73c1d0-8929-4a7e-bcfc-075963101443</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>32ba0096-4ab8-4e55-a8ef-f144567e8c09</TenantId>
      <Url>sample string 3</Url>
      <UserJourneyId>e78e55ce-5a0b-48cb-b942-b16aac5b4199</UserJourneyId>
    </ModuleSettingDto>
    <ModuleSettingDto>
      <Bypassable>true</Bypassable>
      <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
      <DefaultValue>sample string 9</DefaultValue>
      <DisplayName>sample string 4</DisplayName>
      <Id>fb266625-8763-4da2-92a3-481c6f2be7fd</Id>
      <ModuleSettingProperties>
        <ModuleSettingPropertyDto>
          <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
          <Id>544e6bb1-23ea-4b6c-ba66-8e80986b0a22</Id>
          <ModuleSettingId>df73c1d0-8929-4a7e-bcfc-075963101443</ModuleSettingId>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </ModuleSettingPropertyDto>
        <ModuleSettingPropertyDto>
          <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
          <Id>544e6bb1-23ea-4b6c-ba66-8e80986b0a22</Id>
          <ModuleSettingId>df73c1d0-8929-4a7e-bcfc-075963101443</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>32ba0096-4ab8-4e55-a8ef-f144567e8c09</TenantId>
      <Url>sample string 3</Url>
      <UserJourneyId>e78e55ce-5a0b-48cb-b942-b16aac5b4199</UserJourneyId>
    </ModuleSettingDto>
  </ModuleSettings>
  <Name>sample string 2</Name>
  <SortIndex>6</SortIndex>
  <TenantId>da9a6c4e-eccc-49a7-8f7c-9b12cecb5e0d</TenantId>
  <Type>UserJourney</Type>
  <UserJourneyProperties>
    <UserJourneyPropertyDto>
      <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
      <Id>b6153bb9-f304-4db4-8ac6-045f68616d6a</Id>
      <Name>sample string 2</Name>
      <UserJourneyId>8e335d62-7335-4cf5-a3de-88a219156afc</UserJourneyId>
      <Value>sample string 3</Value>
    </UserJourneyPropertyDto>
    <UserJourneyPropertyDto>
      <CreationDate>2025-12-06T03:11:38.5570457+00:00</CreationDate>
      <Id>b6153bb9-f304-4db4-8ac6-045f68616d6a</Id>
      <Name>sample string 2</Name>
      <UserJourneyId>8e335d62-7335-4cf5-a3de-88a219156afc</UserJourneyId>
      <Value>sample string 3</Value>
    </UserJourneyPropertyDto>
  </UserJourneyProperties>
</UserJourneyDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"5f552fb7-acc3-43de-8f58-9037dbb471e8"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5f552fb7-acc3-43de-8f58-9037dbb471e8</guid>