Cancel campaign

curl --request POST \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/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 => [
    "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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "alreadyProcessedCount": 123,
  "campaignID": "<string>",
  "canceledCount": 123
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "CampaignNotFoundError",
      "error_code": 1740,
      "message": "Campaign not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "CampaignNotAcceptCancelError",
      "error_code": 1780,
      "message": "Only scheduled or processing campaigns can be canceled.",
      "statusCode": 422
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Campaigns

Cancel campaign

Cancels a campaign in scheduled OR processing status (extends the legacy core-api endpoint, which only accepted scheduled) — a POST action route instead of the legacy’s DELETE, since this is a state transition, not a resource deletion. Only dispatches still pending/ processing are canceled; already-finished ones are left untouched (fixes the legacy’s unconditional updateMany). The dispatch engine (talqui-core-api) independently checks campaign.campaignStatus before every send, so messages already in the SQS queue at the moment of cancellation are skipped rather than sent once this lands.

POST

tenants

{tenantID}

campaigns

{campaignID}

cancel

Cancel campaign

curl --request POST \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/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 => [
    "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://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/campaigns/{campaignID}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "alreadyProcessedCount": 123,
  "campaignID": "<string>",
  "canceledCount": 123
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "CampaignNotFoundError",
      "error_code": 1740,
      "message": "Campaign not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "CampaignNotAcceptCancelError",
      "error_code": 1780,
      "message": "Only scheduled or processing campaigns can be canceled.",
      "statusCode": 422
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Authorizations

Authorization

string

header

required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID

string

required

campaignID

string

required

Response

Response for status 200.

alreadyProcessedCount

number

required

Dispatches already success/failure/canceled before this call — untouched.

campaignID

string

required

canceledCount

number

required

Dispatches that were pending/processing and are now canceled.

⌘I

Real Time API

Services API

Helpdesk API

Cancel campaign

Authorizations

Path Parameters

Response