journeys-v2

Create a new journey

post/v2/journeys

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/journeys
  • Auth: API key in header X-Api-Key

Request body

namestring required

Journey name, up to 255 characters

priorityinteger
startStepIdstring

Defaults to the first step when steps are provided

statusstring

Initial journey status

Example request

{
  "steps": [
    {
      "stepType": "send_message"
    }
  ],
  "trigger": {
    "conditions": [
      {
        "conditionType": "list"
      }
    ],
    "operator": "AND"
  }
}

Response

Journey created

messagestring
successboolean

Example response

{
  "journey": {
    "steps": [
      {
        "stepType": "send_message"
      }
    ],
    "trigger": {
      "conditions": [
        {
          "conditionType": "list"
        }
      ],
      "operator": "AND"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.