GET Api/V1/Journey/GetJourneyAutomation

Request Information

URI Parameters

None.

Body Parameters

JourneyStructure
NameDescriptionTypeAdditional information
Id

integer

None.

BrandId

integer

None.

UserId

integer

None.

Name

string

None.

Description

string

None.

Priority

string

None.

Status

string

None.

Schedule

Schedule

None.

Actions

Collection of Actions

None.

Metrics

Metrics

None.

Audiences

Collection of Audiences

None.

Settings

Settings

None.

Trigger

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "BrandId": 2,
  "UserId": 3,
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Priority": "sample string 6",
  "Status": "sample string 7",
  "Schedule": {
    "Start": "2026-01-18T08:20:28.9449707+02:00",
    "End": "2026-01-18T08:20:28.9449707+02:00",
    "LastRun": "2026-01-18T08:20:28.9449707+02:00",
    "NextRun": "2026-01-18T08:20:28.9449707+02:00"
  },
  "Actions": [
    {
      "Id": 1,
      "Type": "sample string 2",
      "To": "sample string 3",
      "Subject": "sample string 4",
      "Body": "sample string 5",
      "Attachments": "sample string 6"
    },
    {
      "Id": 1,
      "Type": "sample string 2",
      "To": "sample string 3",
      "Subject": "sample string 4",
      "Body": "sample string 5",
      "Attachments": "sample string 6"
    }
  ],
  "Metrics": {
    "Executions": 1,
    "Successes": 2,
    "Failures": 3
  },
  "Audiences": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ],
  "Settings": {
    "Retries": 1,
    "Timeout": "sample string 2"
  },
  "Trigger": "sample string 8"
}

application/xml, text/xml

Sample:
<JourneyStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HDPro.Core.Manager">
  <Actions>
    <Actions>
      <Attachments>sample string 6</Attachments>
      <Body>sample string 5</Body>
      <Id>1</Id>
      <Subject>sample string 4</Subject>
      <To>sample string 3</To>
      <Type>sample string 2</Type>
    </Actions>
    <Actions>
      <Attachments>sample string 6</Attachments>
      <Body>sample string 5</Body>
      <Id>1</Id>
      <Subject>sample string 4</Subject>
      <To>sample string 3</To>
      <Type>sample string 2</Type>
    </Actions>
  </Actions>
  <Audiences>
    <Audiences>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Audiences>
    <Audiences>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Audiences>
  </Audiences>
  <BrandId>2</BrandId>
  <Description>sample string 5</Description>
  <Id>1</Id>
  <Metrics>
    <Executions>1</Executions>
    <Failures>3</Failures>
    <Successes>2</Successes>
  </Metrics>
  <Name>sample string 4</Name>
  <Priority>sample string 6</Priority>
  <Schedule>
    <End>2026-01-18T08:20:28.9449707+02:00</End>
    <LastRun>2026-01-18T08:20:28.9449707+02:00</LastRun>
    <NextRun>2026-01-18T08:20:28.9449707+02:00</NextRun>
    <Start>2026-01-18T08:20:28.9449707+02:00</Start>
  </Schedule>
  <Settings>
    <Retries>1</Retries>
    <Timeout>sample string 2</Timeout>
  </Settings>
  <Status>sample string 7</Status>
  <Trigger>sample string 8</Trigger>
  <UserId>3</UserId>
</JourneyStructure>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'JourneyStructure'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.