Push
Create a Push Campaign
Create a push campaign draft
POST
/
api
/
v1
/
push
/
campaigns
Create a Push Campaign
curl --request POST \
--url https://api.sequenzy.com/api/v1/push/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"targetLists": {},
"title": "<string>",
"body": "<string>",
"url": {},
"imageUrl": {},
"iconUrl": {},
"platforms": [
"<string>"
]
}
'import requests
url = "https://api.sequenzy.com/api/v1/push/campaigns"
payload = {
"name": "<string>",
"targetLists": {},
"title": "<string>",
"body": "<string>",
"url": {},
"imageUrl": {},
"iconUrl": {},
"platforms": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
targetLists: {},
title: '<string>',
body: JSON.stringify('<string>'),
url: {},
imageUrl: {},
iconUrl: {},
platforms: ['<string>']
})
};
fetch('https://api.sequenzy.com/api/v1/push/campaigns', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'targetLists' => [
],
'title' => '<string>',
'body' => '<string>',
'url' => [
],
'imageUrl' => [
],
'iconUrl' => [
],
'platforms' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sequenzy.com/api/v1/push/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"targetLists\": {},\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"url\": {},\n \"imageUrl\": {},\n \"iconUrl\": {},\n \"platforms\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"targetLists\": {},\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"url\": {},\n \"imageUrl\": {},\n \"iconUrl\": {},\n \"platforms\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"targetLists\": {},\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"url\": {},\n \"imageUrl\": {},\n \"iconUrl\": {},\n \"platforms\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaign": {
"id": "cmp_abc123",
"name": "Flash sale",
"type": "push",
"status": "draft",
"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": "url: Use an https:// URL, an app deep link (myapp://...), or a merge tag"
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:write"
}
Create a Push Campaign
Creates a push campaign draft. You can set content and audience now or later with Update a push campaign, then send it. Requires thecampaigns:write scope.
Request
string
default:"Untitled push campaign"
Campaign name.
object
Audience, same shape as campaign
targetLists: {"type":"all"}, {"type":"lists","listIds":[...]}, {"type":"segment","segmentId":"..."}, or {"type":"rules","include":[...]}. Only contacts with an active push device receive the campaign.string
Notification title, up to 120 characters. Merge tags such as
{{FIRST_NAME|there}} work.string
Notification message, up to 500 characters. Merge tags work.
string | null
Link opened on tap: an https URL, an app deep link (
myapp://...), or a merge
tag. Browsers only open https links. null clears it.string | null
Optional https image shown in the notification.
string | null
Optional https icon for web push. Defaults to the icon in push settings.
string[]
Limit delivery to
web, ios, and/or android. Omit or pass [] for every
platform.curl -X POST "https://api.sequenzy.com/api/v1/push/campaigns" \
--header "Authorization: Bearer $SEQUENZY_API_KEY" \
--header "Content-Type: application/json" \
--data '{"name":"Flash sale","title":"24h sale","body":"30% off everything","url":"https://shop.example.com/sale","targetLists":{"type":"all"}}'
Responses
{
"success": true,
"campaign": {
"id": "cmp_abc123",
"name": "Flash sale",
"type": "push",
"status": "draft",
"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": "url: Use an https:// URL, an app deep link (myapp://...), or a merge tag"
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:write"
}
⌘I
Create a Push Campaign
curl --request POST \
--url https://api.sequenzy.com/api/v1/push/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"targetLists": {},
"title": "<string>",
"body": "<string>",
"url": {},
"imageUrl": {},
"iconUrl": {},
"platforms": [
"<string>"
]
}
'import requests
url = "https://api.sequenzy.com/api/v1/push/campaigns"
payload = {
"name": "<string>",
"targetLists": {},
"title": "<string>",
"body": "<string>",
"url": {},
"imageUrl": {},
"iconUrl": {},
"platforms": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
targetLists: {},
title: '<string>',
body: JSON.stringify('<string>'),
url: {},
imageUrl: {},
iconUrl: {},
platforms: ['<string>']
})
};
fetch('https://api.sequenzy.com/api/v1/push/campaigns', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'targetLists' => [
],
'title' => '<string>',
'body' => '<string>',
'url' => [
],
'imageUrl' => [
],
'iconUrl' => [
],
'platforms' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sequenzy.com/api/v1/push/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"targetLists\": {},\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"url\": {},\n \"imageUrl\": {},\n \"iconUrl\": {},\n \"platforms\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"targetLists\": {},\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"url\": {},\n \"imageUrl\": {},\n \"iconUrl\": {},\n \"platforms\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"targetLists\": {},\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"url\": {},\n \"imageUrl\": {},\n \"iconUrl\": {},\n \"platforms\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaign": {
"id": "cmp_abc123",
"name": "Flash sale",
"type": "push",
"status": "draft",
"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": "url: Use an https:// URL, an app deep link (myapp://...), or a merge tag"
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:write"
}