Skip to content

Tool

create_journey

Create journey

SurfacesChat agentMCPCLI

Create a new email automation journey (draft) for an audience. A journey is a triggered, multi-step sequence (e.g. a 3-email welcome series). It starts in 'draft' with no steps — add steps with add_journey_step, then activate_journey to turn it on. Optionally set a trigger (e.g. { type: "api_event" } for contacts enrolled via enroll_in_journey, or { type: "signup" }).

CLI: tinbox create-journey

Parameters

NameTypeRequiredDescription
audienceIdstringyesThe audience (mailing list) this journey runs against.
namestringyesA name for the journey (e.g. 'Welcome series').
triggerobjectnoHow contacts enter the journey. Omit for a manual/api_event default.
▸expand trigger
  • type stringrequired

    Trigger type — one of the engine's exact values: 'api_event' (enroll via API), 'signup' (joins the audience), 'tag_added' (a tag is applied), or 'date_based'. NOT 'subscribe'/'tag'/'date' — those never fire.

  • config object

    Optional trigger-specific config.

allowReentrybooleannoAllow a contact to be enrolled more than once (default false).
rationalestringnoA short 'choices made' note for the review banner — the trigger + shape you chose and why, plus any part of the request the journey can't express (e.g. an unsupported condition). Shown to the operator atop the builder.

Example

json
{
  "audienceId": "aud_…",
  "name": "<name>"
}