Launches a draft or scheduled campaign, starting outreach to matched leads.
The campaign transitions to running status and begins sending messages
according to its schedule and rate limit settings.
Requires campaigns:launch permission.
API key for programmatic access. Keys use the format nl_live_<64 hex>
or nl_test_<64 hex> and are scoped to an account's RBAC permissions.
Campaign ID (MongoDB ObjectId)
"665a1b2c3d4e5f6a7b8c9d0e"
Campaign launched successfully
A campaign orchestrates batch AI-driven outreach to leads.
Unique campaign identifier
Account that owns this campaign
Campaign display name
Reference to the AI agent configuration used for conversations
Messaging channel for outreach
whatsapp, telegram, email Current campaign lifecycle status
draft, scheduled, running, paused, completed Campaign scheduling and rate limit configuration.
Per-lead tracking for the campaign
Aggregate statistics for the campaign.
Basic lead filter criteria.
Advanced filter with multiple conditions.
Explicitly selected lead IDs to include in the campaign