Campaigns
Cancel campaign
Cancel a campaign. Stops dialing and marks it cancelled. This is the REST equivalent of the dashboard’s archive action.
DELETE
/
campaigns
/
{id}
Cancel campaign
curl --request DELETE \
--url https://api.verbeo.ai/v1/campaigns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verbeo.ai/v1/campaigns/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.verbeo.ai/v1/campaigns/{id}', 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.verbeo.ai/v1/campaigns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.verbeo.ai/v1/campaigns/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.verbeo.ai/v1/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.verbeo.ai/v1/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyCancellation is a terminal state. In-flight calls finish; no further calls are placed. Cancelled campaigns remain visible in list and get for record-keeping.
See Campaigns overview and Errors.
Path parameters
string
required
UUID of the campaign.
Request
curl -X DELETE "https://api.verbeo.ai/v1/campaigns/0175091d-2c3b-4aef-8c45-dbbe24f7b3ff" \
-H "Authorization: Bearer YOUR_API_KEY"
await fetch(`https://api.verbeo.ai/v1/campaigns/${campaignId}`, {
method: "DELETE",
headers: { Authorization: `Bearer ${process.env.VERBEO_API_KEY}` },
});
requests.delete(
f"https://api.verbeo.ai/v1/campaigns/{campaign_id}",
headers={"Authorization": f"Bearer {os.environ['VERBEO_API_KEY']}"},
)
Response
200 OK. Returns the orchestrator’s acknowledgement payload.
{
"success": true,
"data": {
"campaign_id": "0175091d-2c3b-4aef-8c45-dbbe24f7b3ff",
"status": "cancelled"
}
}
Errors
| Code | Status | When it happens |
|---|---|---|
CAMPAIGN_NOT_FOUND | 404 | The campaign doesn’t exist in your workspace. |
INVALID_STATUS | 409 | The campaign is already cancelled. |
ORCHESTRATOR_ERROR | 502 | Upstream campaign-orchestrator returned an unexpected error. |
Was this page helpful?
⌘I
Cancel campaign
curl --request DELETE \
--url https://api.verbeo.ai/v1/campaigns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verbeo.ai/v1/campaigns/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.verbeo.ai/v1/campaigns/{id}', 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.verbeo.ai/v1/campaigns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.verbeo.ai/v1/campaigns/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.verbeo.ai/v1/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.verbeo.ai/v1/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body