Skip to main content
POST
Create campaign
Create a new campaign. Without scheduled_start_at it is created as a draft: add leads, then start it with Update campaign status. With scheduled_start_at it is created as scheduled and starts by itself at that time. To change its settings later, use Update campaign. Supported channels:
  • call (default) — outbound voice with an OUTBOUND assistant
  • whatsapp — approved WhatsApp template via one of your senders
  • sms — SMS body from an SMS-capable number (may be temporarily unavailable on the platform)
Fields that don’t belong to the chosen channel are ignored, except phone_number_ids, which only call campaigns accept.

Request body

Shared

string
required
Campaign name. Maximum 255 characters.
string
default:"call"
call, whatsapp, or sms.
string
IANA timezone for the send/call window (e.g. America/New_York). Defaults to the assistant timezone for call campaigns, otherwise your account timezone.
array
Preferred schedule: 1 to 6 daily windows as objects with start and end in HH:MM. Overnight windows are supported when end is earlier than start (e.g. 16:00 → 02:00). Defaults to one window from 09:00 to 18:00.
string
default:"09:00"
Legacy single-window start (HH:MM). Used if schedule_windows is omitted.
string
default:"18:00"
Legacy single-window end (HH:MM). Overnight when end < start.
string
ISO 8601 date and time. Without an offset it is read in the campaign timezone. The date cannot be before today. When set, the campaign is created as scheduled and starts by itself at that time; otherwise it is draft.
array
default:"all 7 days"
Weekdays: monday … sunday.
integer
default:"3"
Max retry attempts per lead. Range: 1–5.
integer
default:"60"
Minutes between retries. Range: 10–4320.
boolean
default:"false"
false keeps the campaign waiting for new leads, which campaigns fed by an automation or the API need. true completes it once every lead has been processed; leads added after that are not contacted until it is started again.

Call campaigns

integer
Required for channel=call. Must be an OUTBOUND assistant you own.
integer
default:"3"
Concurrent calls, up to your plan’s limit (max 10). Defaults to 3, or to your plan’s limit when it is lower.
array
Outbound from-number IDs available to your account. Call campaigns only: sending it for a WhatsApp or SMS campaign returns 422.
boolean
Retry when a call hits voicemail.
boolean
Keep retrying until a boolean post-call goal variable is true.
string
Boolean post-call schema variable name used with retry_on_goal_incomplete.
string
Optional call→text follow-up after max call retries: whatsapp or sms.
integer
Required when fallback_channel=whatsapp.
integer
Required when fallback_channel=whatsapp. Must be an approved template on that sender.
integer
Required when fallback_channel=sms.
string
Required when fallback_channel=sms. Supports {{variable}} placeholders.
object
Maps WhatsApp template placeholders (e.g. "1") to lead variable keys for the fallback send. Must map every placeholder of the template to a lead variable, and nothing else.

WhatsApp campaigns

integer
Required for channel=whatsapp. Sender you own.
integer
Required for channel=whatsapp. Approved template on that sender.
object
Maps template placeholders (e.g. "1") to lead variable keys. Must map every placeholder of the template to a lead variable, and nothing else.
integer
default:"10"
Per-campaign send rate (1–10). WhatsApp campaigns also share a user-wide pool of 10 in-flight sends across all your active WhatsApp campaigns.

SMS campaigns

integer
Required for channel=sms. Must be SMS-capable and available to you.
string
Required for channel=sms. Max 1600 characters. Supports {{variable}} placeholders.

Response

string
Success message
object
Created campaign (same shape as Get campaign), including channel, schedule, text config, and fallback fields. status is scheduled when scheduled_start_at is set, otherwise draft.

Error responses

Plan limit, invalid assistant/sender/template, disabled channel, or validation errors.