Skip to content

Funnel.create

Saves your path from landing page to opt-in to Sequence to offer, so each drop between steps is one number.

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

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

Inputs

NameTypeMeaning
stepsjsonRequired. The pages, Forms, and Sequences in order.
offerOfferEach Funnel’s path ends at one offer, after its landing page, opt-in and Sequence. Optional.

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

Outputs

FieldTypeWhat null means
funnelFunnelNever null: the Funnel 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; Funnel.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 Funnel is saved as the call leaves it, with the Action that changed it.

Emits

Funnel.created with { funnel }

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 Funnel.created delivers the result.

You, to your agent
Save my path: the rent-ledger template page, the email opt-in, the
5-email course, then the Portfolio offer.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Funnel.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.