Create an In-App Campaign

POST

api

in-app

campaigns

curl --request POST \
  --url https://api.sequenzy.com/api/v1/in-app/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "message": {},
  "priority": "<string>",
  "endsAt": {},
  "targetLists": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/in-app/campaigns"

payload = {
    "name": "<string>",
    "message": {},
    "priority": "<string>",
    "endsAt": {},
    "targetLists": {}
}
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>',
    message: {},
    priority: '<string>',
    endsAt: {},
    targetLists: {}
  })
};

fetch('https://api.sequenzy.com/api/v1/in-app/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/in-app/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>',
    'message' => [
        
    ],
    'priority' => '<string>',
    'endsAt' => [
        
    ],
    'targetLists' => [
        
    ]
  ]),
  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/in-app/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"message\": {},\n  \"priority\": \"<string>\",\n  \"endsAt\": {},\n  \"targetLists\": {}\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/in-app/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"message\": {},\n  \"priority\": \"<string>\",\n  \"endsAt\": {},\n  \"targetLists\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/in-app/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  \"message\": {},\n  \"priority\": \"<string>\",\n  \"endsAt\": {},\n  \"targetLists\": {}\n}"

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

{
  "success": true,
  "campaign": {
    "id": "cmp_abc123",
    "name": "New dashboards",
    "type": "in_app",
    "status": "draft",
    "state": "draft",
    "message": {
      "label": "",
      "kind": "message",
      "format": "modal",
      "title": "Hi {{firstName}}, dashboards are here",
      "body": "See every campaign at a glance.",
      "buttons": [
        {
          "label": "Take a look",
          "action": "open_url",
          "url": "myapp://dashboards"
        }
      ]
    },
    "priority": "high",
    "endsAt": "2026-12-01T00:00:00.000Z",
    "targetLists": {
      "type": "segment",
      "segmentId": "seg_123"
    },
    "scheduledAt": null,
    "sentAt": null,
    "estimatedRecipientCount": null,
    "labelIds": [],
    "createdAt": "2026-11-07T12:00:00.000Z",
    "updatedAt": "2026-11-08T09:00:00.000Z"
  }
}

{
  "error": "message.buttons.0.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"
}

Creates an in-app campaign draft: one in-app message or content card for an audience. You can set the message, priority, end time and audience now or later with Update an In-App Campaign, then launch it with Launch an In-App Campaign. Requires the campaigns:write scope.

Request

string

default:"Untitled in-app campaign"

Campaign name, up to 255 characters.

object

The message, with the same fields as an in-app sequence step: kind (message or card), format (modal, banner, fullscreen or html), position, eyebrow, title, body, imageUrl, imagePlacement, buttons (up to two, each with label, action and url), data, style, pinned, expiresAfterDays, html and showCloseButton. Merge tags such as {{firstName}} are filled for each contact when their app receives it. expiresAfterDays limits how long a contact keeps it after receiving it; without it, the item stays until the campaign ends or the contact dismisses it.

string

default:"medium"

low, medium or high. Apps show one message at a time; when several are waiting, higher priority comes first. Sequence messages count as medium.

string | null

ISO 8601 time the campaign ends. After it, nobody new gets the campaign and it leaves every feed that still has it, including cards contacts have seen but not dismissed. null means it runs until stopped.

object

Audience, the same shape as campaign targetLists: {"type":"all"}, {"type":"lists","listIds":[...]}, {"type":"segment","segmentId":"..."} or {"type":"rules","include":[...],"exclude":[...]}. Email status doesn’t matter. Each contact is checked when their app fetches its feed while the campaign is live.

curl -X POST "https://api.sequenzy.com/api/v1/in-app/campaigns" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name": "New dashboards", "message": {"kind": "message", "format": "modal", "title": "Hi {{firstName}}, dashboards are here", "buttons": [{"label": "Take a look", "url": "myapp://dashboards"}]}, "priority": "high", "targetLists": {"type": "segment", "segmentId": "seg_123"}}'

Responses

{
  "success": true,
  "campaign": {
    "id": "cmp_abc123",
    "name": "New dashboards",
    "type": "in_app",
    "status": "draft",
    "state": "draft",
    "message": {
      "label": "",
      "kind": "message",
      "format": "modal",
      "title": "Hi {{firstName}}, dashboards are here",
      "body": "See every campaign at a glance.",
      "buttons": [
        {
          "label": "Take a look",
          "action": "open_url",
          "url": "myapp://dashboards"
        }
      ]
    },
    "priority": "high",
    "endsAt": "2026-12-01T00:00:00.000Z",
    "targetLists": {
      "type": "segment",
      "segmentId": "seg_123"
    },
    "scheduledAt": null,
    "sentAt": null,
    "estimatedRecipientCount": null,
    "labelIds": [],
    "createdAt": "2026-11-07T12:00:00.000Z",
    "updatedAt": "2026-11-08T09:00:00.000Z"
  }
}

{
  "error": "message.buttons.0.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 an In-App Campaign

curl --request POST \
  --url https://api.sequenzy.com/api/v1/in-app/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "message": {},
  "priority": "<string>",
  "endsAt": {},
  "targetLists": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/in-app/campaigns"

payload = {
    "name": "<string>",
    "message": {},
    "priority": "<string>",
    "endsAt": {},
    "targetLists": {}
}
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>',
    message: {},
    priority: '<string>',
    endsAt: {},
    targetLists: {}
  })
};

fetch('https://api.sequenzy.com/api/v1/in-app/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/in-app/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>',
    'message' => [
        
    ],
    'priority' => '<string>',
    'endsAt' => [
        
    ],
    'targetLists' => [
        
    ]
  ]),
  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/in-app/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"message\": {},\n  \"priority\": \"<string>\",\n  \"endsAt\": {},\n  \"targetLists\": {}\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/in-app/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"message\": {},\n  \"priority\": \"<string>\",\n  \"endsAt\": {},\n  \"targetLists\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/in-app/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  \"message\": {},\n  \"priority\": \"<string>\",\n  \"endsAt\": {},\n  \"targetLists\": {}\n}"

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

{
  "success": true,
  "campaign": {
    "id": "cmp_abc123",
    "name": "New dashboards",
    "type": "in_app",
    "status": "draft",
    "state": "draft",
    "message": {
      "label": "",
      "kind": "message",
      "format": "modal",
      "title": "Hi {{firstName}}, dashboards are here",
      "body": "See every campaign at a glance.",
      "buttons": [
        {
          "label": "Take a look",
          "action": "open_url",
          "url": "myapp://dashboards"
        }
      ]
    },
    "priority": "high",
    "endsAt": "2026-12-01T00:00:00.000Z",
    "targetLists": {
      "type": "segment",
      "segmentId": "seg_123"
    },
    "scheduledAt": null,
    "sentAt": null,
    "estimatedRecipientCount": null,
    "labelIds": [],
    "createdAt": "2026-11-07T12:00:00.000Z",
    "updatedAt": "2026-11-08T09:00:00.000Z"
  }
}

{
  "error": "message.buttons.0.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"
}

​Request

​Responses

Request

Responses