Skip to content

Sequence.create

Saves a timed series of emails and tasks: the steps, the waits between them and what ends a run.

Action class
None
Approval
Runs on its own
Emits
Sequence.created
Price
Free
POST https://api.sb/{your-domain}/sequences

It extends the hub’s record call Sequence.create, which every Sequence takes. It is one of the Verbs of Sequences.

Inputs

NameTypeMeaning
stepsjsonRequired. The steps, waits, and branches.
exitOnstringThe Events that end it from any step, such as a reply or a purchase. Optional.

The hub inherits this call on every Noun: it takes the Sequence’s own Properties, listed on the hub’s Sequence page.

Outputs

FieldTypeWhat null means
sequenceSequenceNever null: the Sequence as the call leaves it.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Sequence.created fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

The Sequence is saved as the call leaves it, with the Action that changed it.

Emits

Sequence.created with { sequence }

Performed by

Whichever seat calls it

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Sequence.created delivers the result.

You, to your agent
Save a three-email first touch: day 0, day 3, day 8, and stop on any
reply.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Sequence.create",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

None.