Skip to main content
POST
Create Campaign

Authorizations

Authorization
string
header
required

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

Body

application/json

Campaign/batch calling request.

agent_id
string<uuid>
required
name
string
required
Required string length: 1 - 255
targets
CallTarget · object[]
required
Required array length: 1 - 1000 elements
schedule_at
string<date-time> | null
concurrent_calls
integer
default:1
Required range: 1 <= x <= 10
retry_failed
boolean
default:false
retry_attempts
integer
default:0
Required range: 0 <= x <= 3
context
Context · object | null
webhook_url
string | null

URL for campaign progress webhooks

webhook_secret
string | null

Secret for webhook signature verification

notify_on_call_complete
boolean
default:false

Send webhook for each call completion

Response

Successful Response

Campaign response.

campaign_id
string
required
agent_id
string
required
name
string
required
total_targets
integer
required
status
string
required
scheduled_at
string | null
required
started_at
string | null
required
calls_initiated
integer
required
calls_completed
integer
required
calls_failed
integer
required