Skip to main content
DELETE
/
campaigns
/
{campaignId}
Delete a campaign (?confirm=true, ?dryRun=true)
curl --request DELETE \
  --url https://origami.chat/api/v2/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://origami.chat/api/v2/campaigns/{campaignId}"

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

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

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://origami.chat/api/v2/campaigns/{campaignId}', 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://origami.chat/api/v2/campaigns/{campaignId}",
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://origami.chat/api/v2/campaigns/{campaignId}"

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://origami.chat/api/v2/campaigns/{campaignId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://origami.chat/api/v2/campaigns/{campaignId}")

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
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "confirmationRequired": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string<uuid>
required

The campaign id (a first-class campaigns row).

Query Parameters

confirm
boolean
default:false

Must be true to actually delete. Omit for the impact preview.

dryRun
boolean
default:false

Force the impact preview even when confirm is set.

Response

The impact preview (unconfirmed / dryRun) or the delete receipt (confirmed).

Impact preview returned by DELETE /campaigns/{campaignId} when ?confirm=true is absent (or ?dryRun=true is set). Nothing has been removed.

id
string<uuid>
required
name
string
required
confirmationRequired
boolean
required
status
enum<string>
required
Available options:
draft,
active,
paused