Skip to main content

​
Overview

The Campaigns API allows you to create and manage voice campaigns for bulk outreach. Campaigns enable you to send voice calls to multiple recipients using your configured agents and phone numbers.

​
Key Features

  • Create campaigns with CSV recipient lists
  • Schedule campaigns for future delivery
  • Send campaigns immediately or schedule for later
  • Track campaign status and recipients
  • Integration with ElevenLabs batch calling

​
Common Use Cases

Create Campaign

Use the POST /campaigns endpoint to create a new campaign with a CSV file of recipients.

List Campaigns

Use the GET /campaigns endpoint to view all your campaigns.

Get Campaign

Use the GET /campaigns/{id} endpoint to retrieve details about a specific campaign.

Schedule Campaign

Set send_immediately: false and provide schedule_date and schedule_time to schedule a campaign.

​
Campaign Properties

Campaigns include the following key properties:
  • id: Unique campaign identifier
  • name: Campaign name
  • status: Current campaign status
  • elevenlabs_batch_call_id: Associated ElevenLabs batch call ID
  • recipients_count: Number of recipients in the campaign
  • scheduled_at: Scheduled delivery timestamp (if scheduled)
  • send_immediately: Whether the campaign was sent immediately
  • created_at: Campaign creation timestamp

​
Creating a Campaign

To create a campaign, you need:
  1. Campaign name: Descriptive name for the campaign
  2. Phone number ID: ID of the phone number to use
  3. Agent ID: ID of the agent to use for calls
  4. Recipients file: CSV file with recipient phone numbers
  5. Send immediately: Boolean flag for immediate or scheduled delivery
  6. Schedule date/time: Optional scheduling information

​
CSV File Format

The recipients file should be a CSV with phone numbers. Example: 
phone_number
+1234567890
+0987654321
+1122334455

​
Scheduling

Campaigns can be sent immediately or scheduled:
  • Immediate: Set send_immediately: true
  • Scheduled: Set send_immediately: false and provide:
    • schedule_date: Date in YYYY-MM-DD format
    • schedule_time: Time in HH:MM:SS format
Ensure your phone number and agent are properly configured before creating a campaign. Campaigns cannot be modified after creation.

​
Endpoints