Turn a journey on or off
Moves the on and off switch of a journey.
PUT https://cotlet.dev/api/v1/campaign-monitor/journeys/{journey_id}/status
write Confirm
Needs the automation permission. Turning on needs every step complete and a monthly billing plan; if the switch is disabled the call returns the unfinished steps. While off, new subscribers cannot trigger the journey, and people inside it keep moving but get no emails. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| journey_id string required | string | Journey ID from list_journeys. |
| state string required | string | on or off. |
Request
curl -X PUT https://cotlet.dev/api/v1/campaign-monitor/journeys/b7d3e9a1c5f84a2e9b6d0c3f1a8e5724/status \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"state":"off"}'result = client.call("campaign-monitor", "set_journey_status", {"journey_id":"b7d3e9a1c5f84a2e9b6d0c3f1a8e5724","state":"off"})const result = await cotlet.call('campaign-monitor', 'set_journey_status', {"journey_id":"b7d3e9a1c5f84a2e9b6d0c3f1a8e5724","state":"off"});cotlet call campaign-monitor set_journey_status --data '{"journey_id":"b7d3e9a1c5f84a2e9b6d0c3f1a8e5724","state":"off"}'Example response
{
"journey_id": "b7d3e9a1c5f84a2e9b6d0c3f1a8e5724",
"name": "Welcome series",
"status": "paused",
"previous_status": "active",
"subscribers_waiting": 214
}