Skip to main content
POST
This endpoint is for the VIP plan only. Other plans get a 403. See Plan access.
A campaign calls everyone in a contact view, with one voice agent, inside the days and hours you set. It is a draft until you set it live. When it goes live, it adds the contacts in the view right away, and keeps the list in step with the view after that. Before each call, the dialer checks DND and opt-outs. It never calls a contact with DND on.
​
string
The workspace. Required for an account key. A workspace key uses its own workspace.
​
string
required
The campaign name, up to 200 characters.
​
string
required
The voice agent that places the calls. It must be in the same workspace.
​
string
required
The contact view that decides who gets called. It must be in the same workspace. Create views with the contact views endpoints.
​
integer
required
Talk minutes the campaign may use each day. When it reaches this, its status becomes capped until the next calling day.
​
integer
default:"0"
Calls after the first one. 0 means call each contact once.
​
integer[]
required
Days the campaign calls on. 1 is Monday and 7 is Sunday.
​
string
required
When calling starts each day, like 09:00. On the quarter hour, and not before 9am.
​
string
required
When calling stops each day, like 17:00. On the quarter hour, after the start, and not after 8pm.
​
string
A timezone for every contact, like America/New_York. Leave it out or send null to use each contact’s own timezone. A zone that names no place, like UTC, GMT or a fixed offset, gets a 400.
​
string
default:"draft"
draft or live. A live campaign starts calling at once. A locked workspace cannot add a campaign.

​
Errors