Lead methods: nurture, qualify

Reference for Lead, one group of Lead methods.

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. Verb page.

TypeScript

interface LeadVerbs {
  nurture(input: LeadNurtureInput, options?: SB.CallOptions): SB.Call<Lead>
}

Inputs

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

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

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

Qualify confirms a Lead matches an Offer’s ICP and opens a Deal for it. Verb page.

TypeScript

interface LeadVerbs {
  qualify(input: LeadQualifyInput, options?: SB.CallOptions): SB.Call<LeadQualifyOutput>
}

Inputs

Input	Type	Required	Description
`lead`	Lead	required	The Lead to qualify.
`offer`	Offer	required	The Offer whose ICP the Lead matches.

Returns

Output	Type	Required	Description
`deal`	Deal	required	The open Deal.
`lead`	Lead	required	The Lead, now qualified.

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.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const { deal, lead } = await $.Lead.qualify({ lead: 'lead_Kz1R9fhqzZ', offer: 'offer_2hzYe1ERo0' })