Sequence · StartupBuilder

Properties

Property	Type	Required	Description
`steps`	`json`	required	The steps, waits, and branches.
`exitOn`	`string`		The Events that end it from any step, such as a reply or a purchase.

JSON

{
  "$id": "https://api.sb/patentpad.com/sequences/sequence_1",
  "$type": "Sequence",
  "steps": {},
  "exitOn": "Example exit on"
}

A Sequence has many Enrollments: the Sequence whose steps this Enrollment walks, one step at a time. enrollments, inverse follows.
A Sequence enrolls many Contacts: a Sequence runs for an enrolled Contact until a reply, a purchase, or another exit Event ends it. enrolls, inverse enrolledIn.
A Sequence nurtures many Funnels: a Funnel follows up with each new Lead through Sequences after the opt-in. nurtures, inverse nurturesWith.
A Sequence schedules many Messages: a Sequence sends Messages, each at its own step and wait. schedules, inverse scheduledBy.

createCreates a Sequence.
POST /{namespace}/sequencesdoSequence.created
getReturns one Sequence by id.
GET /{namespace}/sequences/{id}readNo Event
listReturns Sequences, newest first, one page at a time.
GET /{namespace}/sequencesreadNo Event
updateChanges the given properties of a Sequence.
PATCH /{namespace}/sequences/{id}doSequence.updated
deleteDeletes a Sequence; its history is kept.
DELETE /{namespace}/sequences/{id}doSequence.deleted

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Sequence.create`	Yes	Yes	Yes	No
`Sequence.get`	Yes	Yes	Yes	Yes
`Sequence.list`	Yes	Yes	Yes	Yes
`Sequence.update`	Yes	Yes	Yes	No
`Sequence.delete`	Yes	Yes	Yes	No

Text

Add a sequence to ShiftNote.

A trial Sequence sends a welcome Message, waits 3 days, then sends a setup tip only if the Contact has made no API call.