Manage Campaign

Get details, update, pause/resume, and delete campaigns.

PUT/v2/accounts/{account_sid}/campaigns/{campaign_id}

Get Campaign Details

Returns the full campaign object including current stats.

Update Campaign Action

Pause, resume, complete, or archive a campaign.

Request Body

{ "action": "pause" }

Allowed Actions

Action	From Status	Description
pause	Created, InProgress	Temporarily stop the campaign
resume	Paused	Resume a paused campaign
complete	Paused	Force complete — marks remaining calls as failed
archive	Completed	Archive a completed campaign

Code Examples

cURL

curl -u '<api_key>:<api_token>' -X PUT "https://api.exotel.com/v2/accounts/<sid>/campaigns/<campaign_id>" \
  -H "Content-Type: application/json" \
  -d '{ "action": "pause" }'

Python

import requests
import json

response = requests.put(
    'https://api.exotel.com/v2/accounts/<sid>/campaigns/<campaign_id>',
    auth=('<api_key>', '<api_token>'),
    headers={'Content-Type': 'application/json'},
    data=json.dumps({'action': 'pause'})
)

print(response.json())

Node.js

const apiKey = '<api_key>';
const apiToken = '<api_token>';
const accountSid = '<sid>';
const campaignId = '<campaign_id>';

const url = `https://api.exotel.com/v2/accounts/${accountSid}/campaigns/${campaignId}`;

const response = await fetch(url, {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic ' + Buffer.from(`${apiKey}:${apiToken}`).toString('base64'),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ action: 'pause' }),
});

const data = await response.json();
console.log(data);

PHP

<?php
$payload = json_encode(array(
  "action" => "pause"
));

$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_USERPWD => "<api_key>:<api_token>",
  CURLOPT_URL => "https://api.exotel.com/v2/accounts/<sid>/campaigns/<campaign_id>",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => $payload,
  CURLOPT_HTTPHEADER => array("Content-Type: application/json"),
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>

Go

package main

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

func main() {
    url := "https://api.exotel.com/v2/accounts/<sid>/campaigns/<campaign_id>"
    payload := strings.NewReader(`{ "action": "pause" }`)

    req, _ := http.NewRequest("PUT", url, payload)
    req.SetBasicAuth("<api_key>", "<api_token>")
    req.Header.Add("Content-Type", "application/json")

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

    body, _ := ioutil.ReadAll(res.Body)
    fmt.Println(string(body))
}

Update Campaign Details

Update campaign parameters before the send_at time. After send_at, only callbacks and action can be updated.

Accepts the same parameters as Create Campaign.

Editable after send_at:

• action
• status_callback
• call_status_callback
• call_schedule_callback

Delete Campaign

Returns HTTP 200 on success.

---

List All Campaigns

Query Parameters

Parameter	Type	Default	Description
offset	Integer	0	Zero-based record position
limit	Integer	20	Records per page (max 500)
name	String	—	Search by campaign name
status	String	—	Filter by comma-separated statuses
sort_by	String	—	date_created:asc, date_created:desc, name:asc, name:desc
type	String	trans	Campaign type

Code Examples

cURL

curl -u '<api_key>:<api_token>' "https://api.exotel.com/v2/accounts/<sid>/campaigns?limit=10&status=InProgress,Paused&sort_by=date_created:desc"

Python

import requests

response = requests.get(
    'https://api.exotel.com/v2/accounts/<sid>/campaigns',
    auth=('<api_key>', '<api_token>'),
    params={
        'limit': 10,
        'status': 'InProgress,Paused',
        'sort_by': 'date_created:desc',
    }
)

print(response.json())

Node.js

const apiKey = '<api_key>';
const apiToken = '<api_token>';
const accountSid = '<sid>';

const params = new URLSearchParams({
  limit: '10',
  status: 'InProgress,Paused',
  sort_by: 'date_created:desc',
});

const url = `https://api.exotel.com/v2/accounts/${accountSid}/campaigns?${params}`;

const response = await fetch(url, {
  headers: {
    'Authorization': 'Basic ' + Buffer.from(`${apiKey}:${apiToken}`).toString('base64'),
  },
});

const data = await response.json();
console.log(data);

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_USERPWD => "<api_key>:<api_token>",
  CURLOPT_URL => "https://api.exotel.com/v2/accounts/<sid>/campaigns?limit=10&status=InProgress,Paused&sort_by=date_created:desc",
  CURLOPT_RETURNTRANSFER => true,
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>

Go

package main

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

func main() {
    url := "https://api.exotel.com/v2/accounts/<sid>/campaigns?limit=10&status=InProgress,Paused&sort_by=date_created:desc"

    req, _ := http.NewRequest("GET", url, nil)
    req.SetBasicAuth("<api_key>", "<api_token>")

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

    body, _ := ioutil.ReadAll(res.Body)
    fmt.Println(string(body))
}

Response

{
  "request_id": "req_abc123",
  "http_code": 200,
  "metadata": {
    "count": 3,
    "offset": 0,
    "total": 138,
    "limit": 10
  },
  "response": [
    { "...campaign objects..." }
  ]
}

Try It