Skip to main content
POST
Create Campaign
Before creating a campaign, upload your contacts CSV to get a source_url. Set telephony_configuration_id to pin the campaign to a specific telephony configuration. If omitted, SentiVue Talk falls back to the organization’s default outbound configuration — supplying an id that doesn’t exist in your organization returns 400 telephony_configuration_not_found. The time_slots field controls when SentiVue Talk is allowed to place calls. If omitted, calls can be placed at any time. The timezone field applies to all time slot windows.
Once created, the campaign is in draft status. Call Start to begin dialing.

Headers

authorization
string | null
X-API-Key
string | null

Body

application/json
name
string
required
Required string length: 1 - 255
workflow_id
string
required
source_type
string
required
Pattern: ^csv$
source_id
string
required
telephony_configuration_id
string | null
retry_config
RetryConfigRequest · object | null
max_concurrency
integer | null
Required range: 1 <= x <= 100
schedule_config
ScheduleConfigRequest · object | null
circuit_breaker
CircuitBreakerConfigRequest · object | null

Response

Successful Response

id
string
required
name
string
required
workflow_id
string
required
workflow_name
string
required
state
string
required
source_type
string
required
source_id
string
required
total_rows
integer | null
required
processed_rows
integer
required
failed_rows
integer
required
created_at
string<date-time>
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
retry_config
RetryConfigResponse · object
required
max_concurrency
integer | null
schedule_config
ScheduleConfigResponse · object | null
circuit_breaker
CircuitBreakerConfigResponse · object | null
executed_count
integer
default:0
total_queued_count
integer
default:0
contact_count
integer
default:0
in_flight_count
integer
default:0
failed_count
integer
default:0
retry_count
integer
default:0
retries_pending
integer
default:0
retry_breakdown
RetryBreakdownResponse · object

Retry attempts split by the outcome that triggered them.

parent_campaign_id
string | null
redialed_campaign_id
string | null
telephony_configuration_id
string | null
telephony_configuration_name
string | null
logs
CampaignLogEntryResponse · object[]