Skip to main content
PATCH
JavaScript

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

workerId
string
required
deploymentId
string
required
campaignId
string
required

Body

application/json
name
string
description
string
status
enum<string>
Available options:
CREATED,
STARTED,
RUNNING,
COMPLETED,
STOPPED,
FAILED
data
object[]
batch_size
integer
batch_interval_minutes
integer
additional_data
object
telephonyProvider
object

Response

Campaign updated 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