journeys-v2

Update a journey

put/v2/journeys/{journey_id}

Request

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

Request body

namestring

Journey name

priorityinteger
startStepIdstring
status'draft' | 'active' | 'paused' | 'archived'

Example request

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

Response

Journey updated

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.