Skip to content

Lead.nurture

Takes a lead that is not ready to buy off its owner’s queue and onto a Sequence, until it raises a hand again.

Action class
send
Approval
Sends on its own
Emits
Lead.nurtured
Price
Free
POST https://api.sb/{your-domain}/leads/{lead}/nurture

Its Inputs, Outputs, Effects and guards quote the hub’s Lead.nurture; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of CRM.

Inputs

NameTypeMeaning
leadLeadRequired. The lead to nurture.
sequenceSequenceThe Sequence to enroll it in. Optional.

Outputs

FieldTypeWhat null means
leadLeadNever null: the lead, now in nurture.

Effects

Action class

send: an approval rule on send can make it wait for your OK

Modes
  • try: Runs every check and returns what would go out, as it would go out; nothing is sent, posted or spent.
  • send: Returns a pending Action at once; Lead.nurtured 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

Enrolls the lead in the Sequence when one is given. Its next reply or form puts it back on a queue through Lead.assign.

Emits

Lead.nurtured with { lead }

Performed by

Sales lead

Price

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

Standing approval

It goes out on its own, inside the Limits of your standing approval: a Mandate you grant once with Mandate.authorize. One approval rule makes it wait for your OK.

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 Lead.nurtured delivers the result.

You, to your agent
Rosa said “next quarter”: put her on the monthly rent-tips sequence
until she raises a hand.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Lead.nurture",
    "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.