Skip to main content
POST
JavaScript

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

workerId
string
required
deploymentId
string
required

Body

application/json
data
object[]
required

Contact data array

name
string

Campaign name

description
string

Campaign description

batch_size
integer
default:1

Number of calls to make simultaneously

batch_interval_minutes
integer
default:2

Minutes to wait between batches

additional_data
object

Additional metadata

telephonyProvider
object

Telephony provider configuration

status
enum<string>

Campaign status

Available options:
CREATED,
STARTED,
RUNNING,
COMPLETED,
STOPPED,
FAILED
created_by
string

User ID who created the campaign

team_id
string

Team ID

flow_id
string

Flow ID

Response

Campaign created successfully

id
string
required
status
string
required
data
object
required
batchSize
integer
required
batchIntervalMinutes
integer
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deploymentId
string
required
workerId
string
required
teamId
string
required
name
string | null
description
string | null
additionalData
object | null
telephonyProvider
object | null
flowId
string | null
createdById
string | null