Skip to main content

Communications: campaign forecast, sending limits and pacing

  • Forecast. POST /campaigns/{id}/compile and /schedule return forecast (estimated_completion_at, limiting_cap, the caps used, enforced) and warnings (will_take_hours, will_span_multiple_days). Call compile first to see the audience size and the time before you schedule.
  • Pacing. The campaign list, detail and report carry pacing: not_started, running, waiting_for_cap (with the reason, burst, hourly, daily, acct_hourly or acct_daily, and resumes_at), done or stopped. A campaign waiting for a limit is not stuck: it continues by itself when the hour or day rolls over. The report adds sent and remaining.
  • A campaign that can never be sent is refused. 400 CAMPAIGN_CANNOT_COMPLETE (reason: too_long or cap_zero) when, at your limits, it would take longer than the maximum (7 days). Only when limits are enforced for campaigns; until then forecast.enforced is false and nothing changes.

Documentation changed