Skip to main content
POST
Create a campaign

Authorizations

x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Body

application/json
name
string
required
agentId
string<uuid>
required
contacts
object[]
contactIds
string<uuid>[]
active
boolean
default:true
scheduled
boolean
default:false
launch
boolean
default:false
startTime
string
endTime
string
timezone
string
Example:

"America/New_York"

followUpCall
boolean
default:false
followUpAttempts
integer
Required range: 1 <= x <= 10
followUpIntervals
integer[]

Delay in minutes before each follow-up. One value per attempt.

Response

Campaign created

success
boolean
Example:

true

data
object
warning
string
requestId
string | null