Skip to main content
POST
/
call
/
campaign
Create Campaign (v1)
curl --request POST \
  --url https://api.callkaro.ai/call/campaign \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Sales Campaign Q1",
  "agent_id": "6803fa770b666a64ab1694c1e"
}
'
{
  "batch_id": "68433b7b0dee98e59245ebab",
  "message": "Campaign created successfully",
  "status": "success"
}
Create a campaign to organize multiple calls under a single ID. Requires an agent_id that will be used for all calls in this campaign.

​
Quick Example

curl -X POST https://api.callkaro.ai/call/campaign \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key_here" \
  -d '{
    "name": "Sales Campaign Q1",
    "agent_id": "6803fa770b666a64ab1694c1e"
  }'

​
Workflow

1

Create the campaign

curl -X POST https://api.callkaro.ai/call/campaign \
  -H "X-API-KEY: your_api_key_here" \
  -d '{
    "name": "Inspection Campaign",
    "agent_id": "6803fa770b666a64ab1694c1e"
  }'
Response:
{
  "batch_id": "68433b7b0dee98e59245ebab",
  "message": "Campaign created successfully",
  "status": "success"
}
2

Add calls to the campaign

Use the batch_id from step 1 with the outbound call API:
curl -X POST https://api.callkaro.ai/call/outbound \
  -H "X-API-KEY: your_api_key_here" \
  -d '{
    "to_number": "+919876543210",
    "batch_id": "68433b7b0dee98e59245ebab",
    "agent_id": "6803fa770b666a64ab1694c1e",
    "metadata": {
      "name": "Abhinav",
      "city": "Bangalore"
    },
    "schedule_at": "2025-12-31T09:30:00",
    "min_trigger_time": "09:00",
    "max_trigger_time": "18:00",
    "number_of_retries": 3,
    "gap_between_retries": 30
  }'
3

Monitor in dashboard

Track campaign performance at /dashboard/batch-calls/{batch_id}

​
When to Use v1

Use Campaign v1 when:
  • ✅ All calls will use the same agent
  • ✅ You have the agent ID ready
  • ✅ You want simpler campaign management
Need flexibility? Use Campaign v2 if you want to use different agents for different calls in the same campaign.

​
Response

​
Success (200 OK)

{
  "batch_id": "68433b7b0dee98e59245ebab",
  "message": "Campaign created successfully",
  "status": "success"
}
Save the batch_id - you’ll need it to add calls to this campaign!

​
Tips

Organize your campaigns: Use descriptive names like “Q1 Sales Outreach” or “December Follow-ups” to easily identify them in the dashboard.
Same agent requirement: All calls added to a v1 campaign must use the same agent_id that was specified when creating the campaign.

Authorizations

​
X-API-KEY
string
header
required

API key from https://callkaro.ai/dashboard/api-key

Body

application/json
​
name
string
required

Campaign name for identification and organization

Required string length: 1 - 200
Example:

"Sales Campaign Q1"

​
agent_id
string
required

ID of the agent that will be used for all calls in this campaign

Example:

"6803fa770b666a64ab1694c1e"

Response

Campaign created successfully

​
batch_id
string

Unique identifier for the created campaign

Example:

"68433b7b0dee98e59245ebab"

​
message
string
Example:

"Campaign created successfully"

​
status
string
Example:

"success"