Skip to content

by Startups.Studio

Growth Contact Lead

Lead.nurture

POST /{namespace}/leads/{lead}/nurture

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.

Noun: Lead
Mode: do
Event: Lead.nurtured

You, to your agent

Nurture the latest lead.

curl -X POST https://api.sb/shiftnote.app/leads/lead_1/nurture \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const lead = await $.Lead.nurture({ lead: 'lead_1' })

npx startup-builder do Lead.nurture --json '{"lead":"lead_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Lead.nurture({ lead: 'lead_1' })"
  }
}

Inputs

Input	Type	Required	Description
`lead`	Lead	required	The Lead to nurture.
`sequence`	Sequence		The Sequence to enroll it in.

Outputs

Output	Type	Required	Description
`lead`	Lead	required	The Lead, now in `nurture`.

Effects

Emits Lead.nurtured.
Performed by the Sales Lead.
Two-way: it runs at once, in the try, send and do modes.
Enrolls the Lead in the Sequence when one is given.
Its next reply or form puts it back on a queue through Lead.assign.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Lead.nurture

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Lead.list

Previous Page

Lead.qualify

Next Page