Sign in
latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-15394599.9 KB

58dc5cff0ca7

Campaigns

Create a campaign

Creates a new outbound dialing campaign.

The campaign will begin dialing contacts within the time_start–time_end window on the specified days. If timezone is omitted the organization's default timezone is used.

post/v2/campaigns

Request body

namestring required
type'outbound' required
agent_uidstring required
from_numberstring required

E.164 format.

contact_list_idinteger required
time_startstring required

HH:MM format.

time_endstring required

HH:MM format.

timezonestring
daysCampaignDay[]

Example request

{
  "time_start": "09:00",
  "time_end": "17:00",
  "timezone": "America/New_York"
}

Response

Campaign created.

idinteger required
namestring required
type'outbound' required
status'Running' | 'Scheduled' | 'Stopped' | 'Completed' | 'Failed' | 'Expired' | 'Paused' required
agent_uidstring
from_numberstring
contact_list_idinteger
time_startstring

HH:MM (24-hour) daily window start.

time_endstring

HH:MM (24-hour) daily window end.

timezonestring
daysCampaignDay[]
created_atstring date-time
updated_atstring date-time

Example response

{
  "time_start": "09:00",
  "time_end": "17:00",
  "timezone": "America/New_York"
}