Create Campaign

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"
}
'

import requests

url = "https://api.callkaro.ai/call/campaign"

payload = {
    "name": "Sales Campaign Q1",
    "agent_id": "6803fa770b666a64ab1694c1e"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Sales Campaign Q1', agent_id: '6803fa770b666a64ab1694c1e'})
};

fetch('https://api.callkaro.ai/call/campaign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.callkaro.ai/call/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Sales Campaign Q1',
    'agent_id' => '6803fa770b666a64ab1694c1e'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.callkaro.ai/call/campaign"

	payload := strings.NewReader("{\n  \"name\": \"Sales Campaign Q1\",\n  \"agent_id\": \"6803fa770b666a64ab1694c1e\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.callkaro.ai/call/campaign")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sales Campaign Q1\",\n  \"agent_id\": \"6803fa770b666a64ab1694c1e\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.callkaro.ai/call/campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Sales Campaign Q1\",\n  \"agent_id\": \"6803fa770b666a64ab1694c1e\"\n}"

response = http.request(request)
puts response.read_body

{
  "batch_id": "68433b7b0dee98e59245ebab",
  "message": "Campaign created successfully",
  "status": "success"
}

{
  "status": "error",
  "message": "Missing name in body"
}

{
  "status": "error",
  "message": "Missing required field: to_number"
}

{
  "status": "error",
  "message": "Agent not found!"
}

POST

call

campaign

Create Campaign

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"
}
'

import requests

url = "https://api.callkaro.ai/call/campaign"

payload = {
    "name": "Sales Campaign Q1",
    "agent_id": "6803fa770b666a64ab1694c1e"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Sales Campaign Q1', agent_id: '6803fa770b666a64ab1694c1e'})
};

fetch('https://api.callkaro.ai/call/campaign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.callkaro.ai/call/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Sales Campaign Q1',
    'agent_id' => '6803fa770b666a64ab1694c1e'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.callkaro.ai/call/campaign"

	payload := strings.NewReader("{\n  \"name\": \"Sales Campaign Q1\",\n  \"agent_id\": \"6803fa770b666a64ab1694c1e\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.callkaro.ai/call/campaign")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sales Campaign Q1\",\n  \"agent_id\": \"6803fa770b666a64ab1694c1e\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.callkaro.ai/call/campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Sales Campaign Q1\",\n  \"agent_id\": \"6803fa770b666a64ab1694c1e\"\n}"

response = http.request(request)
puts response.read_body

{
  "batch_id": "68433b7b0dee98e59245ebab",
  "message": "Campaign created successfully",
  "status": "success"
}

{
  "status": "error",
  "message": "Missing name in body"
}

{
  "status": "error",
  "message": "Missing required field: to_number"
}

{
  "status": "error",
  "message": "Agent not found!"
}

Create a campaign to organize multiple calls under a single ID. agent_id is optional: include it to attach one agent to the whole campaign, or leave it out and choose an agent for each call.

Quick Example

With an agent attached to the campaign:

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"
  }'

Without an agent (choose one per call later):

curl -X POST https://api.callkaro.ai/call/campaign \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key_here" \
  -d '{
    "name": "Multi-Agent Campaign"
  }'

Workflow

Create the campaign

curl -X POST https://api.callkaro.ai/call/campaign \
  -H "Content-Type: application/json" \
  -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"
}

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 "Content-Type: application/json" \
  -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
  }'

Monitor in dashboard

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

With or without an agent ID

With agent_id — calls you add without their own agent_id use the campaign’s agent, so you can send just the batch_id. A call can still pass its own agent_id.
Without agent_id — each call you add must include its own agent_id, so you can use a different agent for every call in the same campaign. This is handy when you don’t have the agent ready yet.

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!

Errors

Status	Message	When
400	`Missing name in body`	`name` was not sent
400	`You don't have enough credits. Recharge now!`	`agent_id` sent, and a prepaid account has no credits
400	`Buy Phone Number`	`agent_id` sent, but neither the agent nor the account has a phone number
403	`Missing X-API-KEY in headers`	No API key header
403	`API KEY Mismatch`	`agent_id` sent, but it does not belong to this API key
404	`Agent not found!`	`agent_id` sent, but no such agent exists

Tips

Organize your campaigns: Use descriptive names like “Q1 Sales Outreach” or “December Follow-ups” to easily identify them in the dashboard.

Check the agent when adding calls: If the campaign was created without an agent_id and a call is added without one either, the call is rejected with no agent found with given batch_id.

Authorizations

X-API-KEY

string

header

required

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

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"

​Quick Example

​Workflow

​With or without an agent ID

​Response

​Success (200 OK)

​Errors

​Tips

Authorizations

Response

Quick Example

Workflow

With or without an agent ID

Response

Success (200 OK)

Errors

Tips