Instantiate a journey template
Clone a prebuilt journey template from the catalog into a new draft campaign (type=‘journey’) in the caller’s tenant. The template’s node + edge graph is serialised onto the campaign so the journey builder re-opens it verbatim; all body fields are optional overrides (name, description, channel, audience). Returns 201 with the created campaign — continue in the journey builder, then launch via POST /campaigns/:id/send.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Path Parameters
Catalog template id, e.g. 'welcome-series'.
1 - 64Body
Campaign display name — defaults to the template's name.
1 - 200Optional campaign description — defaults to the template's.
1000Override of the inferred default channel (list filtering + billing reporting); per-node channels in the graph are not mutated.
sms, mms, whatsapp, email, rcs, viber, voice, push, instagram, messenger, line, telegram, fax Audience strategy override; 'manual' is the picker-approved hand-picked roster.
all, list, segment, csv, manual Identifier of the chosen list/segment when audience_type is set.
1 - 128