Skip to main content
PATCH
Update a campaign. Allowed on DRAFT and PAUSED campaigns.
Required scope: campaigns.edit
Scopes apply to scoped API keys. Keys issued without scopes can call every /v1 endpoint.

Authorizations

Authorization
string
header
required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id
string
required

Body

application/json
name
string
required
Required string length: 1 - 100
description
string | null
Maximum string length: 280
agentId
string
Minimum string length: 1
channel
enum<string>
Available options:
VOICE,
WHATSAPP,
VOICE_THEN_WHATSAPP,
WHATSAPP_THEN_VOICE,
CUSTOM,
EMAIL
whatsappOutreachTemplateId
string | null
whatsappTemplateByMetric
object
messageDeclinedLeads
boolean
workflowId
string | null
dailyMessageCap
integer | null
Required range: 1 <= x <= 100000
outreachRules
object[] | null
Maximum array length: 20
reservedConcurrency
integer
Required range: 1 <= x <= 10
variableMap
object
uploadId
string
countryCode
string
Pattern: ^\+\d{1,3}$
phoneColumn
string
altPhoneColumns
string[]
Maximum array length: 5
Minimum string length: 1
nameColumn
string
firstNameColumn
string
lastNameColumn
string
removeInvalidRows
boolean
transliterateCalleeNames
boolean
timezone
string
scheduledStartAt
string<date-time>
scheduledEndAt
string<date-time>
dailyWindowStart
string
Pattern: ^\d{2}:\d{2}$
dailyWindowEnd
string
Pattern: ^\d{2}:\d{2}$
retryCount
integer
Required range: 0 <= x <= 10
cooldownMinutes
integer
Required range: 5 <= x <= 43200
retryDelaysMinutes
integer[]
Maximum array length: 10
Required range: 1 <= x <= 43200
retryConcurrencyPercent
integer | null
Required range: 0 <= x <= 100
notificationUserIds
string[]
campaignTypeId
string | null
customExtractionKeys
object[]
Maximum array length: 40
source
enum<string>
Available options:
CSV,
CRM_MANUAL,
CRM_WEBHOOK,
API
defaultCrmConnectionId
string | null
defaultCrmSegmentId
string | null
contactMergeMode
enum<string>
Available options:
APPEND,
REPLACE
followupEnabled
boolean
followupMaxAttempts
integer
Required range: 1 <= x <= 10
churnEnabled
boolean
churnMaxAttempts
integer
Required range: 1 <= x <= 10
churnIntervalHours
integer
Required range: 1 <= x <= 2160
churnDelaysHours
integer[]
Maximum array length: 10
Required range: 1 <= x <= 2160
goal
string | null
Maximum string length: 500
briefText
string | null
Maximum string length: 200000
briefFileName
string | null
Maximum string length: 255
incompleteRetryEnabled
boolean
incompleteRetryMaxAttempts
integer
Required range: 1 <= x <= 5
incompleteRetryIntervalMinutes
integer
Required range: 1 <= x <= 1440
incompleteRetryDelaysMinutes
integer[]
Maximum array length: 5
Required range: 1 <= x <= 1440
incompleteCallSeconds
integer
Required range: 5 <= x <= 300
referralMaxDepth
integer
Required range: 0 <= x <= 3
skipRetryOnFirstVoicemail
boolean
messageRetryEnabled
boolean
messageRetryMaxAttempts
integer
Required range: 1 <= x <= 10
messageRetryIntervalSeconds
integer
Required range: 1 <= x <= 604800
messageRetryDelaysSeconds
integer[]
Maximum array length: 10
Required range: 1 <= x <= 604800
messageRetryWindowSeconds
integer
Required range: 1 <= x <= 2592000
messageRetryTieredEnabled
boolean
messageRetryTransientMaxAttempts
integer
Required range: 1 <= x <= 100
autoReseedEnabled
boolean
incompleteRetryBackfillToday
boolean
incompleteRetryBackfill
object
churnBackfill
object
dailyDialCap
integer | null
Required range: 1 <= x <= 100000
dialDays
integer[]
Required array length: 1 - 7 elements
Required range: 0 <= x <= 6
evaluationMetrics
object[]
Maximum array length: 12

Response

OK

id
string
required
name
string
required
agentId
string | null
required
agentName
string | null
required
channel
enum<string>
required
Available options:
VOICE,
WHATSAPP,
VOICE_THEN_WHATSAPP,
WHATSAPP_THEN_VOICE,
CUSTOM,
EMAIL
status
string
required
reservedConcurrency
number
required
variableMap
object
required
startedAt
string | null
required
endedAt
string | null
required
createdAt
string
required
updatedAt
string
required
campaignTypeId
string | null
required
campaignTypeName
string | null
required
customExtractionKeys
object[]
required
effectiveExtractionKeys
object[]
required
notificationUserIds
string[]
required
source
enum<string>
required
Available options:
CSV,
CRM_MANUAL,
CRM_WEBHOOK,
API,
INBOUND
defaultCrmConnectionId
string | null
required
defaultCrmSegmentId
string | null
required
description
string | null
whatsappOutreachTemplateId
string | null
whatsappTemplateByMetric
unknown
messageDeclinedLeads
boolean
dailyMessageCap
number | null
outreachRules
object[] | null
Maximum array length: 20
whatsappEnabled
boolean
whatsappAgentTemplateIds
string[]
whatsappAutomations
object[]
workflowId
string | null
countryCode
string | null
phoneColumn
string | null
altPhoneColumns
string[]
removeInvalidRows
boolean
transliterateCalleeNames
boolean
uploadId
string | null
timezone
string | null
scheduledStartAt
string | null
scheduledEndAt
string | null
dailyWindowStart
string | null
dailyWindowEnd
string | null
retryCount
number
cooldownMinutes
number
retryDelaysMinutes
number[]
retryConcurrencyPercent
number | null
followupEnabled
boolean
followupMaxAttempts
number
churnEnabled
boolean
churnMaxAttempts
number
churnIntervalHours
number
churnDelaysHours
number[]
goal
string | null
incompleteRetryEnabled
boolean
incompleteRetryMaxAttempts
number
incompleteRetryIntervalMinutes
number
incompleteRetryDelaysMinutes
number[]
incompleteCallSeconds
number
referralMaxDepth
number
skipRetryOnFirstVoicemail
boolean
messageRetryEnabled
boolean
messageRetryMaxAttempts
number
messageRetryIntervalSeconds
number
messageRetryDelaysSeconds
number[]
messageRetryWindowSeconds
number
messageRetryTieredEnabled
boolean
messageRetryTransientMaxAttempts
number
autoReseedEnabled
boolean
briefFileName
string | null
briefUploadedAt
string | null
briefText
string | null
dailyDialCap
number | null
dialDays
number[]
evaluationMetrics
object[]
Maximum array length: 12
contactCount
number
receivedCalls
number