Start Campaign

POST

campaign

start

Start Campaign

curl --request POST \
  --url https://prod-api.revenueable.ai/ca/api/v0/campaign/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",
  "from_numbers": [
    "+1234567890"
  ]
}
'

import requests

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

payload = {
    "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
    "list_id": "123e4567-e89b-12d3-a456-426614174000",
    "from_numbers": ["+1234567890"]
}
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',
    from_numbers: ['+1234567890']
  })
};

fetch('https://prod-api.revenueable.ai/ca/api/v0/campaign/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.revenueable.ai/ca/api/v0/campaign/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',
    'from_numbers' => [
        '+1234567890'
    ]
  ]),
  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.revenueable.ai/ca/api/v0/campaign/start"

	payload := strings.NewReader("{\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"from_numbers\": [\n    \"+1234567890\"\n  ]\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.revenueable.ai/ca/api/v0/campaign/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  \"from_numbers\": [\n    \"+1234567890\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.revenueable.ai/ca/api/v0/campaign/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  \"from_numbers\": [\n    \"+1234567890\"\n  ]\n}"

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

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

{
  "detail": "Invalid agent_id."
}

{
  "detail": "Invalid credentials"
}

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

Campaign Start Process

This endpoint starts a previously uploaded campaign by initiating outbound calls to all contacts in the specified campaign list.

Before starting a campaign, ensure you have:

Uploaded a contact list using the campaign upload endpoint
Configured your agent with the appropriate prompts and settings
Set up valid from_numbers that are provisioned for your workspace

Request Parameters

Parameter	Type	Required	Description
`agent_id`	string	✅	ID of the agent that will handle all campaign calls
`list_id`	string	✅	ID of the uploaded campaign contact list
`from_numbers`	array	✅	Phone numbers to use for outbound calls

Important Notes

Credits Required: Ensure your workspace has sufficient credits for all contacts in the campaign
International Calls: For international numbers, only Twilio from_numbers are supported
Campaign Status: Once started, the campaign status changes to “scheduled” or “ongoing”
Duplicate Prevention: Cannot start a campaign that’s already in “scheduled” or “ongoing” status

Error Responses

400: Invalid agent_id, campaign not found, insufficient credits, or campaign already started
401: Invalid or missing API key
404: Campaign or agent not found
402: Insufficient credits to initiate campaign

Headers

X-API-KEY

string

required

(Required) Your Revenueable 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"

from_numbers

string[]

required

(Required) Array of phone numbers to use for outbound calls.

Example:

["+1234567890", "+0987654321"]

Response

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

Get All CampaignsRetrieves a paginated list of campaigns for the current user with optional call count information.

Start Campaign

curl --request POST \
  --url https://prod-api.revenueable.ai/ca/api/v0/campaign/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",
  "from_numbers": [
    "+1234567890"
  ]
}
'

import requests

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

payload = {
    "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
    "list_id": "123e4567-e89b-12d3-a456-426614174000",
    "from_numbers": ["+1234567890"]
}
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',
    from_numbers: ['+1234567890']
  })
};

fetch('https://prod-api.revenueable.ai/ca/api/v0/campaign/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.revenueable.ai/ca/api/v0/campaign/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',
    'from_numbers' => [
        '+1234567890'
    ]
  ]),
  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.revenueable.ai/ca/api/v0/campaign/start"

	payload := strings.NewReader("{\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"from_numbers\": [\n    \"+1234567890\"\n  ]\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.revenueable.ai/ca/api/v0/campaign/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  \"from_numbers\": [\n    \"+1234567890\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.revenueable.ai/ca/api/v0/campaign/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  \"from_numbers\": [\n    \"+1234567890\"\n  ]\n}"

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

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

{
  "detail": "Invalid agent_id."
}

{
  "detail": "Invalid credentials"
}

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

Get Started

Webhooks Setup

API Reference

Campaign Start Process

Request Parameters

Important Notes

Error Responses

Headers

Body

Response

​Campaign Start Process

​Request Parameters

​Important Notes

​Error Responses

Headers

Body

Response

Campaign Start Process

Request Parameters

Important Notes

Error Responses