Creates a new campaign in draft status. The campaign must reference a valid
agent configuration and optionally include lead filters, scheduling, and
channel settings. Requires campaigns:create 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.
Request body for creating a new campaign.
Campaign display name
ID of the agent configuration to use for conversations
Messaging channel for outreach
whatsapp, telegram, email Basic lead filter criteria.
Advanced filter with multiple conditions.
Explicitly selected lead IDs to include
Campaign scheduling and rate limit configuration.
Campaign created 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