Skip to content

CLI command

tinbox create-journey

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" }).

Generated from tool: create_journey

Usage

sh
tinbox create-journey --audienceId <audienceId> --name <name> --trigger <trigger> [--allowReentry] --rationale <rationale>

Flags

NameTypeRequiredDefaultDescription
--audienceIdstringyes—The audience (mailing list) this journey runs against.
--namestringyes—A name for the journey (e.g. 'Welcome series').
--triggerstringyes—How contacts enter the journey. Omit for a manual/api_event default.
--allowReentrybooleanno—Allow a contact to be enrolled more than once (default false).
--rationalestringyes—A 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.