Skip to main content
POST
Creates a draft sequence from a template returned by List Sequence Templates, exactly as New sequence does in the dashboard. Requires the sequences:write scope. Every successful call creates another sequence, so do not retry after a success. What you get:
  • Push-first branch. Templates with channelStrategy: "push_first_email_fallback" start with a branch on whether the contact is reachable by push, meaning an active device on a platform you have set up (APNs, FCM or web push). Those contacts get the push and in-app steps; everyone else gets the email steps. In-app messages reach both, the next time the app opens.
  • Quiet hours. Every wait ends inside the template’s daytime window (09:00 to 21:00) in each contact’s own timezone, falling back to UTC.
  • Stop conditions. The template’s continue condition becomes the sequence stop condition, so a contact leaves once they convert.
  • Frequency cap. Email steps respect your company frequency cap when the template enables it. Push and in-app steps are not counted against it.
  • Goal. The template’s attribution goal is created on the sequence, so conversions show in its results.
Emails are written by AI from your brand in the background, usually within 30 to 60 seconds; poll Get Sequence. Push and in-app copy comes from the template: review it before you enable the sequence. Calendar templates that count down to key dates (Black Friday) return 400; create those in the dashboard or with Create Sequence and keyDates.

Request

string
required
Template id, such as mobile-trial-conversion.
string
Sequence name, up to 255 characters. Defaults to the template name.

Response

object

Errors