Push
Stop a Push Campaign
Stop a scheduled or sending push campaign
POST
/
api
/
v1
/
push
/
campaigns
/
{campaignId}
/
cancel
Stop a Push Campaign
curl --request POST \
--url https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/push/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://api.sequenzy.com/api/v1/push/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://api.sequenzy.com/api/v1/push/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://api.sequenzy.com/api/v1/push/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))
}HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/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{
"success": true,
"campaign": {
"id": "cmp_abc123",
"name": "Flash sale",
"type": "push",
"status": "cancelled",
"content": {
"title": "24h sale",
"body": "30% off everything",
"url": "https://shop.example.com/sale",
"imageUrl": null,
"iconUrl": null,
"platforms": [
"web",
"ios"
]
},
"targetLists": {
"type": "all"
},
"scheduledAt": null,
"sentAt": null,
"estimatedRecipientCount": null,
"labelIds": [],
"createdAt": "2026-10-01T12:00:00.000Z",
"updatedAt": "2026-10-01T12:00:00.000Z"
}
}
{
"error": "This campaign is not a push campaign."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:send"
}
{
"error": "Campaign not found."
}
{
"error": "Only scheduled or sending push campaigns can be stopped."
}
Stop a Push Campaign
Stops a scheduled or sending push campaign. Contacts who have not been sent the push yet are skipped with the reasoncampaign_cancelled; delivered notifications cannot be recalled. POST /api/v1/campaigns/{campaignId}/cancel does the same for push campaigns. Requires the campaigns:send scope.
Request
string
required
The push campaign ID.
curl -X POST "https://api.sequenzy.com/api/v1/push/campaigns/cmp_abc123/cancel" \
--header "Authorization: Bearer $SEQUENZY_API_KEY"
Responses
{
"success": true,
"campaign": {
"id": "cmp_abc123",
"name": "Flash sale",
"type": "push",
"status": "cancelled",
"content": {
"title": "24h sale",
"body": "30% off everything",
"url": "https://shop.example.com/sale",
"imageUrl": null,
"iconUrl": null,
"platforms": [
"web",
"ios"
]
},
"targetLists": {
"type": "all"
},
"scheduledAt": null,
"sentAt": null,
"estimatedRecipientCount": null,
"labelIds": [],
"createdAt": "2026-10-01T12:00:00.000Z",
"updatedAt": "2026-10-01T12:00:00.000Z"
}
}
{
"error": "This campaign is not a push campaign."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:send"
}
{
"error": "Campaign not found."
}
{
"error": "Only scheduled or sending push campaigns can be stopped."
}
⌘I
Stop a Push Campaign
curl --request POST \
--url https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/push/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://api.sequenzy.com/api/v1/push/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://api.sequenzy.com/api/v1/push/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://api.sequenzy.com/api/v1/push/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))
}HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/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{
"success": true,
"campaign": {
"id": "cmp_abc123",
"name": "Flash sale",
"type": "push",
"status": "cancelled",
"content": {
"title": "24h sale",
"body": "30% off everything",
"url": "https://shop.example.com/sale",
"imageUrl": null,
"iconUrl": null,
"platforms": [
"web",
"ios"
]
},
"targetLists": {
"type": "all"
},
"scheduledAt": null,
"sentAt": null,
"estimatedRecipientCount": null,
"labelIds": [],
"createdAt": "2026-10-01T12:00:00.000Z",
"updatedAt": "2026-10-01T12:00:00.000Z"
}
}
{
"error": "This campaign is not a push campaign."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:send"
}
{
"error": "Campaign not found."
}
{
"error": "Only scheduled or sending push campaigns can be stopped."
}