Skip to main content
POST
Create outbound campaign

Authorizations

Authorization
string
header
required

Developer key created from the dashboard (Settings → Developer Keys)

Body

application/json
projectId
string
required
Minimum string length: 1
fromNumber
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
schedule
object
required
contacts
object[]
required
Minimum array length: 1
description
string
status
enum<string>
default:draft
Available options:
draft,
active
retryPolicy
object | null

Re-dial contacts whose call went unanswered. Only the retry count is configurable. The qualifying outcomes are fixed: no answer (userNoAnswer), voicemail and busy always re-dial; a declined call (userRejected) or an invalid number never does. Retries are placed after every never-dialed contact, and each one waits at least 2 hours after the previous attempt (spread by up to +25%), even when nothing else is left to dial. Omit or null for no retries.

Response

Campaign created

campaignId
string
required
status
string
required
totalContacts
number
required
duplicatesSkipped
number
required