Start Campaign (Number Pool)

Initiates a new campaign using a managed number pool for outbound calls. Numbers are resolved automatically from the pool (rotation, spam skipping, auto-purchase).

POST /campaign/v2/start

Start Campaign (Number Pool)

cURL

curl --request POST \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
  "list_id": "123e4567-e89b-12d3-a456-426614174000",
  "number_pool_id": "pool-uuid-here"
}
'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start"

payload = {
    "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
    "list_id": "123e4567-e89b-12d3-a456-426614174000",
    "number_pool_id": "pool-uuid-here"
}
headers = {
    "X-API-KEY": "<x-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': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: '830f767a-397e-4b39-82ff-235cd344e2f9',
    list_id: '123e4567-e89b-12d3-a456-426614174000',
    number_pool_id: 'pool-uuid-here'
  })
};

fetch('https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start', 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://prod-api.ringg.ai/ca/api/v0/campaign/v2/start",
  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([
    'agent_id' => '830f767a-397e-4b39-82ff-235cd344e2f9',
    'list_id' => '123e4567-e89b-12d3-a456-426614174000',
    'number_pool_id' => 'pool-uuid-here'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-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://prod-api.ringg.ai/ca/api/v0/campaign/v2/start"

	payload := strings.NewReader("{\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"number_pool_id\": \"pool-uuid-here\"\n}")

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

	req.Header.Add("X-API-KEY", "<x-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://prod-api.ringg.ai/ca/api/v0/campaign/v2/start")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"number_pool_id\": \"pool-uuid-here\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"number_pool_id\": \"pool-uuid-here\"\n}"

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

200

{
  "status": "campaign registered successfully!",
  "has_ongoing_calls": false
}

{
  "detail": "Number pool not found."
}

{
  "detail": "Invalid credentials"
}

{
  "detail": "An unexpected error occurred."
}

Start a campaign using a managed number pool. Numbers are resolved automatically from the pool — handling rotation, spam skipping, and auto-purchase — so you don’t need to specify individual from_numbers.

Before starting a campaign, ensure you have:

• Uploaded a contact list using Upload campaign contact list
• Configured your agent with the appropriate prompts and settings
• Created a number pool and added numbers to it

Request parameters

Parameter	Type	Required	Description
agent_id	string	Yes	ID of the agent that will handle all campaign calls
list_id	string	Yes	ID of the uploaded campaign contact list
number_pool_id	string	Yes	ID of the managed number pool to use for outbound calls
callback_url	string	No	URL to receive a webhook when the campaign completes
email_completion_user_ids	array	No	User IDs to notify by email on campaign completion

Standard flow

1. Upload contacts with Upload campaign contact list.
2. Save the returned list_id.
3. Start calls with this endpoint using a number_pool_id.
4. Monitor progress with Get all campaigns.

Error responses

• 400: Invalid agent_id, list_id, or number_pool_id; campaign already started
• 401: Invalid or missing API key
• 500: Unexpected server error

Headers

X-API-KEY · string · required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Body

application/json

agent_id · string · required

(Required) ID of the agent that will handle the calls.

Example:

"830f767a-397e-4b39-82ff-235cd344e2f9"

list_id · string · required

(Required) ID of the uploaded campaign contact list.

Example:

"123e4567-e89b-12d3-a456-426614174000"

number_pool_id · string · required

(Required) ID of the managed number pool to use for outbound calls.

Example:

"pool-uuid-here"

callback_url · string | null

URL to receive campaign completion webhook.

Example:

"https://api.example.com/ringg/campaign-callback"

email_completion_user_ids · string[] | null

User IDs to notify by email when the campaign completes.

Response

200

application/json

Campaign started successfully.

status · string

Success message indicating campaign registration.

Example:

"campaign registered successfully!"

has_ongoing_calls · boolean

Whether the workspace has other ongoing calls.

Example:

false