TRtreasure
Realtime Journeys

Create a realtime journey

Create a realtime journey.

post/entities/realtime_journeys

Request

Request body

Example request

{
  "attributes": {
    "realtimeJourneyStages": [
      {
        "steps": {
          "58AB9022-B48D-430A-A879-2E13D08CD2C1": {
            "type": "WaitStep",
            "name": "Wait 1 hour",
            "waitStep": 1,
            "waitStepUnit": "hour",
            "next": "428CA341-3C3E-4D38-8D88-A035CE83A1FF"
          },
          "428CA341-3C3E-4D38-8D88-A035CE83A1FF": {
            "type": "TriggeredActivation",
            "name": "Send mail",
            "journeyActivationStepId": "123"
          }
        },
        "rootStep": "58AB9022-B48D-430A-A879-2E13D08CD2C1"
      }
    ]
  }
}

Response

Returns a summary of the journey

Example response

{
  "data": {
    "attributes": {
      "realtimeJourneyStages": [
        {
          "steps": {
            "58AB9022-B48D-430A-A879-2E13D08CD2C1": {
              "type": "WaitStep",
              "name": "Wait 1 hour",
              "waitStep": 1,
              "waitStepUnit": "hour",
              "next": "428CA341-3C3E-4D38-8D88-A035CE83A1FF"
            },
            "428CA341-3C3E-4D38-8D88-A035CE83A1FF": {
              "type": "TriggeredActivation",
              "name": "Send mail",
              "journeyActivationStepId": "123"
            }
          },
          "rootStep": "58AB9022-B48D-430A-A879-2E13D08CD2C1"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.