Skip to main content
POST
Instantiate a journey template

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

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.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox 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.

Available options:
true,
false

Path Parameters

templateId
string
required

Catalog template id, e.g. 'welcome-series'.

Required string length: 1 - 64

Body

application/json
name
string

Campaign display name — defaults to the template's name.

Required string length: 1 - 200
description
string

Optional campaign description — defaults to the template's.

Maximum string length: 1000
channel
enum<string>

Override of the inferred default channel (list filtering + billing reporting); per-node channels in the graph are not mutated.

Available options:
sms,
mms,
whatsapp,
email,
rcs,
viber,
voice,
push,
instagram,
messenger,
line,
telegram,
fax
audience_type
enum<string>

Audience strategy override; 'manual' is the picker-approved hand-picked roster.

Available options:
all,
list,
segment,
csv,
manual
audience_id
string

Identifier of the chosen list/segment when audience_type is set.

Required string length: 1 - 128

Response

The freshly-created draft journey campaign.

The freshly-created draft journey campaign.

data
object
meta
object