Skip to main content
POST
Create Campaign

Authorizations

X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Body

application/json

Create a campaign (public API).

name
string
required
Required string length: 1 - 255
description
string | null
persona_id
string | null

Persona to use

voice_config_id
string | null

Voice agent (infers persona)

call_settings
CallSettingsInput · object | null

Call settings

Example:
metadata
Metadata · object
contact_ids
string[] | null

Contact IDs to add (max 10,000)

Maximum array length: 10000
priority
integer
default:50

Queue priority

Required range: 1 <= x <= 100
scheduled_start_at
string | null

Naive datetime 'YYYY-MM-DDTHH:MM' per contact timezone

auto_start
boolean
default:false

Start immediately after adding contacts

Response

Successful Response

Response after creating a campaign via public API.

id
string
required
name
string
required
status
string
required
created_at
string<date-time>
required
persona_id
string | null
contacts_added
integer | null
scheduled_start_at
string | null