Skip to main content
POST
cURL
The version pin is resolved at creation time and is immutable afterwards — publishing a newer version later never changes what this campaign runs.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
workflow_id
string<uuid>
required

The workflow to run.

name
string
required

Campaign display name.

Required string length: 1 - 120
Example:

"August loan follow-ups"

version
integer | null

Published version to pin. null pins the latest published version at creation time. The pin is immutable after create.

binding
object

Optional per-campaign overrides. agent_overrides maps agent node ids to replacement agent ids; number_overrides maps agent node ids to originating phone numbers.

scheduled_at
string<date-time> | null

Timezone-aware timestamp to start the campaign at. Omit to start manually.

Response

Campaign created

id
string<uuid>
required
name
string
required
workflow_id
string<uuid>
required
workflow_version
integer
required

The pinned published version.

kind
enum<string>
required

batch holds uploaded entries; api is the implicit campaign behind single runs.

Available options:
batch,
continuous,
api
status
enum<string>
required

Lifecycle is draftscheduledrunning → (pausedrunning) → completed or aborted.

Available options:
draft,
scheduled,
running,
paused,
completed,
aborted
scheduled_at
string<date-time> | null
entries_count
integer
success_count
integer
failure_count
integer
neutral_count
integer
terminal_count
integer
created_at
string<date-time>
updated_at
string<date-time>