Campaigns

Execute Campaign

Execute a campaign to process leads from the associated list. Leads are scheduled with time-spreading to avoid carrier spam flagging. Rate limited per business (default: 100 leads/hour).

Authentication

X-API-Keystring
Your API key from [Dashboard → Settings → API Keys](https://dashboard.bookedin.ai/settings)

Request

This endpoint expects an object.
campaign_idstringRequired
Campaign ID to execute
lead_countintegerOptional>=1
Number of leads to process in this batch. If not specified, uses remaining hourly quota.

Response

Campaign execution queued
campaign_idstringOptional
list_idstringOptional
List containing the leads
strategy_idstringOptional
Strategy being executed
total_leadsintegerOptional
Total leads in the campaign list
processed_leadsintegerOptional
Leads already processed
strategies_scheduledintegerOptional
Leads scheduled in this execution
unprocessed_leadsintegerOptional
Remaining leads to process
executions_this_hourintegerOptional

Total executions this hour (business-level)

remaining_this_hourintegerOptional
Remaining executions available this hour
reset_timedoubleOptional
Unix timestamp when rate limit resets
can_continuebooleanOptional
Whether campaign has more leads to process
messagestringOptional

Errors

400
Bad Request Error
402
Payment Required Error
404
Not Found Error
429
Too Many Requests Error