In-app
List In-App Templates
Starting points for in-app sequence steps
GET
/
api
/
v1
/
in-app
/
templates
List In-App Templates
curl --request GET \
--url https://api.sequenzy.com/api/v1/in-app/templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/in-app/templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/in-app/templates', 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/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/in-app/templates"
req, _ := http.NewRequest("GET", 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.get("https://api.sequenzy.com/api/v1/in-app/templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/in-app/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"templates": [
{
"id": "trial-ending",
"name": "Trial ending",
"category": "Conversion",
"description": "A sheet that asks for the upgrade while the trial is fresh.",
"config": {
"kind": "message",
"format": "modal",
"position": "bottom",
"eyebrow": "Trial ends soon",
"title": "Keep everything you've built",
"body": "Upgrade now and your work, settings and history stay exactly where they are.",
"buttons": [
{ "label": "Upgrade", "action": "open_url", "url": "" },
{ "label": "Not now", "action": "dismiss" }
]
}
}
]
}
{
"error": "This API key is missing the sequences:read scope"
}
Returns the built-in templates for in-app sequence steps. Each template’s
config is a complete in-app step without a label: pass it as a type: "in_app" step to Create Sequence or Update Sequence. Link buttons have no url; add the links they open before you use a template, or the step is rejected. Requires the sequences:read scope.
curl "https://api.sequenzy.com/api/v1/in-app/templates" \
--header "Authorization: Bearer $SEQUENZY_API_KEY"
Response
object[]
Templates, each with
id, name, category (Conversion, Onboarding, Announcement or Engagement), description and config.{
"success": true,
"templates": [
{
"id": "trial-ending",
"name": "Trial ending",
"category": "Conversion",
"description": "A sheet that asks for the upgrade while the trial is fresh.",
"config": {
"kind": "message",
"format": "modal",
"position": "bottom",
"eyebrow": "Trial ends soon",
"title": "Keep everything you've built",
"body": "Upgrade now and your work, settings and history stay exactly where they are.",
"buttons": [
{ "label": "Upgrade", "action": "open_url", "url": "" },
{ "label": "Not now", "action": "dismiss" }
]
}
}
]
}
{
"error": "This API key is missing the sequences:read scope"
}
⌘I
List In-App Templates
curl --request GET \
--url https://api.sequenzy.com/api/v1/in-app/templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/in-app/templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/in-app/templates', 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/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/in-app/templates"
req, _ := http.NewRequest("GET", 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.get("https://api.sequenzy.com/api/v1/in-app/templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/in-app/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"templates": [
{
"id": "trial-ending",
"name": "Trial ending",
"category": "Conversion",
"description": "A sheet that asks for the upgrade while the trial is fresh.",
"config": {
"kind": "message",
"format": "modal",
"position": "bottom",
"eyebrow": "Trial ends soon",
"title": "Keep everything you've built",
"body": "Upgrade now and your work, settings and history stay exactly where they are.",
"buttons": [
{ "label": "Upgrade", "action": "open_url", "url": "" },
{ "label": "Not now", "action": "dismiss" }
]
}
}
]
}
{
"error": "This API key is missing the sequences:read scope"
}