Sequences
List Sequence Templates
List the ready-made sequence templates for your company category
GET
/
api
/
v1
/
sequences
/
templates
curl "https://api.sequenzy.com/api/v1/sequences/templates?websiteType=mobile_app" \
-H "Authorization: Bearer $SEQUENZY_API_KEY"
{
"success": true,
"websiteType": "mobile_app",
"templates": [
{
"id": "mobile-trial-conversion",
"name": "Trial to Paid",
"websiteTypes": ["mobile_app"],
"trigger": {
"type": "event_received",
"eventName": "saas.trial_started",
"description": "When a trial starts in RevenueCat, Superwall or Adapty"
},
"continueCondition": { "type": "event_received", "eventName": "saas.purchase", "description": "Stops once they subscribe" },
"channels": ["push", "in_app", "email"],
"channelStrategy": "push_first_email_fallback",
"quietHours": { "startTime": "09:00", "endTime": "21:00" },
"frequencyCapEnabled": true,
"goal": { "name": "Converted to paid", "eventName": "saas.purchase", "valuePropertyName": "amount", "valuePropertyLabel": "Revenue", "attributionWindowHours": 72 },
"requiresIntegration": { "type": "app_subscriptions", "description": "Connect RevenueCat, Superwall or Adapty so trial starts and conversions arrive automatically" },
"steps": [{ "step": 1, "title": "Trial Started", "description": "In-app card confirming the trial and listing what Premium unlocks.", "channel": "in_app", "absoluteDay": 0 }]
}
]
}
Lists the same ready-made templates the dashboard shows under New sequence, including push-first mobile app journeys. Create one with Create Sequence from Template. Requires the
sequences:read scope.
By default the list follows your company category (websiteType from Get Company): templates built for that category come first, then general templates that suit every category. An unclassified company, or other, sees every template.
Query
string
default:"company"
company uses your company category, all lists every template, or name a
category: saas, content, ecommerce, offline, mobile_app or other.
Any other value returns 400.Response
string | null
The category the list was filtered to, or
null when it was not filtered.array
Show template
Show template
string
Template id, such as
mobile-trial-conversion.string
Display name.
string[] | null
Categories it is built for;
null means every category.object
type (contact_added, tag_added, event_received, inactivity or manual), plus eventName, tagName or inactiveDays and a description.object | null
Checked before every step.
has_tag keeps going while the contact has the tag, no_tag while they do not, event_received stops when the event arrives.string[]
Channels the steps use:
push, in_app, email.string | null
push_first_email_fallback: contacts reachable by push get the push and in-app steps, everyone else gets the email steps.object | null
The daytime window, in each contact’s own timezone, that every send waits for.
boolean
Whether email steps respect your frequency cap.
object | null
The attribution goal created with the sequence:
name, eventName, optional valuePropertyName, and attributionWindowHours.object | null
What must be connected for the trigger to fire:
stripe, app_subscriptions (RevenueCat, Superwall or Adapty) or mobile_sdk.array
step, title, description, channel and absoluteDay for each step.curl "https://api.sequenzy.com/api/v1/sequences/templates?websiteType=mobile_app" \
-H "Authorization: Bearer $SEQUENZY_API_KEY"
{
"success": true,
"websiteType": "mobile_app",
"templates": [
{
"id": "mobile-trial-conversion",
"name": "Trial to Paid",
"websiteTypes": ["mobile_app"],
"trigger": {
"type": "event_received",
"eventName": "saas.trial_started",
"description": "When a trial starts in RevenueCat, Superwall or Adapty"
},
"continueCondition": { "type": "event_received", "eventName": "saas.purchase", "description": "Stops once they subscribe" },
"channels": ["push", "in_app", "email"],
"channelStrategy": "push_first_email_fallback",
"quietHours": { "startTime": "09:00", "endTime": "21:00" },
"frequencyCapEnabled": true,
"goal": { "name": "Converted to paid", "eventName": "saas.purchase", "valuePropertyName": "amount", "valuePropertyLabel": "Revenue", "attributionWindowHours": 72 },
"requiresIntegration": { "type": "app_subscriptions", "description": "Connect RevenueCat, Superwall or Adapty so trial starts and conversions arrive automatically" },
"steps": [{ "step": 1, "title": "Trial Started", "description": "In-app card confirming the trial and listing what Premium unlocks.", "channel": "in_app", "absoluteDay": 0 }]
}
]
}
Errors
| Status | When |
|---|---|
400 | websiteType is not a known category, company or all. |
401 | Missing or invalid API key. |
404 | The company no longer exists. |
⌘I
curl "https://api.sequenzy.com/api/v1/sequences/templates?websiteType=mobile_app" \
-H "Authorization: Bearer $SEQUENZY_API_KEY"
{
"success": true,
"websiteType": "mobile_app",
"templates": [
{
"id": "mobile-trial-conversion",
"name": "Trial to Paid",
"websiteTypes": ["mobile_app"],
"trigger": {
"type": "event_received",
"eventName": "saas.trial_started",
"description": "When a trial starts in RevenueCat, Superwall or Adapty"
},
"continueCondition": { "type": "event_received", "eventName": "saas.purchase", "description": "Stops once they subscribe" },
"channels": ["push", "in_app", "email"],
"channelStrategy": "push_first_email_fallback",
"quietHours": { "startTime": "09:00", "endTime": "21:00" },
"frequencyCapEnabled": true,
"goal": { "name": "Converted to paid", "eventName": "saas.purchase", "valuePropertyName": "amount", "valuePropertyLabel": "Revenue", "attributionWindowHours": 72 },
"requiresIntegration": { "type": "app_subscriptions", "description": "Connect RevenueCat, Superwall or Adapty so trial starts and conversions arrive automatically" },
"steps": [{ "step": 1, "title": "Trial Started", "description": "In-app card confirming the trial and listing what Premium unlocks.", "channel": "in_app", "absoluteDay": 0 }]
}
]
}