Switch a journey on or off
set_journey_enabledSwitch a journey on or off. Turning one ON sends nothing at that moment, but from then on it automatically EMAILS the site's real contacts whenever its trigger happens — only when the user asks, and say so plainly before asking them to approve. A journey with errors (or one using a channel that is not available) is refused with problems instead of being enabled. Turning one off stops anyone new entering.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enabled | Yes | true = on (starts emailing contacts when the trigger fires), false = off | |
| site_id | Yes | The site, from list_sites | |
| user_goal | No | Optional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details. | |
| journey_id | Yes | The journey, by id from list_journeys |