Cancel a campaign

curl --request POST \
  --url https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel', 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://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "draft",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_name": "<string>",
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "list_name": "<string>",
  "sender_id": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "recipients": 123,
  "processed": 123,
  "sent": 123,
  "delivered": 123,
  "read": 123,
  "failed": 123,
  "blocked": 123,
  "queued": 123
}

{
  "error": "<string>",
  "details": [
    {}
  ]
}

POST

campaigns

{id}

cancel

Cancel a campaign

curl --request POST \
  --url https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel', 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://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://truecaller.udchowdhury.me/v1/campaigns/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "draft",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_name": "<string>",
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "list_name": "<string>",
  "sender_id": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "recipients": 123,
  "processed": 123,
  "sent": 123,
  "delivered": 123,
  "read": 123,
  "failed": 123,
  "blocked": 123,
  "queued": 123
}

{
  "error": "<string>",
  "details": [
    {}
  ]
}

Authorizations

x-api-key

string

header

required

Workspace API key from Developers → API keys. It starts with tc_live_.

Path Parameters

string<uuid>

required

Response

The campaign, now cancelled.

string<uuid>

name

string

status

enum<string>

Available options:

draft,

scheduled,

running,

completed,

cancelled

template_id

string<uuid>

template_name

string

list_id

string<uuid>

list_name

string

sender_id

string

scheduled_at

string<date-time> | null

started_at

string<date-time> | null

completed_at

string<date-time> | null

note

string | null

Why a running campaign is waiting

recipients

integer

processed

integer

sent

integer

delivered

integer

read

integer

failed

integer

blocked

integer

queued

integer

Tools

WhatsApp

RCS

SMS (India)

SMS (International)

OmniChannel

Verify

Truecaller

Cancel a campaign

Authorizations

Path Parameters

Response