Skip to main content
POST
Create a draft campaign from a journey template

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

templateId
string
required

Identifier of the journey template to clone (e.g. welcome-series), as returned by GET /api/v1/campaigns/templates.

Required string length: 1 - 64

Body

application/json
name
string

Display name for the new campaign. Defaults to the template's name.

Required string length: 1 - 200
description
string

Optional description on the campaign row. Defaults to the template's description.

Maximum string length: 1000
channel
enum<string>

Override the campaign's default channel (used for list filtering and billing reporting only). Defaults to the channel inferred from the template. Per-step channels in the journey graph are not changed.

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

How the audience is selected. Defaults to all (everyone).

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

Identifier of the list, segment, or CSV import to target. Required when audience_type is anything other than all.

Required string length: 1 - 128

Response

Draft campaign created from the template

Draft campaign created from the template

data
object
meta
object