Lead methods: assign, convert, disqualify
The Lead Verbs assign, convert, disqualify as typed SDK methods, with inputs, result, refusals and an example.
Reference for Lead, one group of Lead methods.
Lead.assign
Assign gives a Lead one owner Worker, by round robin, territory or ICP fit, as the Startup’s routing Policy says. Verb page.
interface LeadVerbs {
assign(input: LeadAssignInput, options?: SB.CallOptions): SB.Call<Lead>
}Emits Lead.assigned.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
lead | Lead | required | The Lead to route. |
owner | Worker | The Worker to own it; omitted, the routing Policy picks. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
lead | Lead | required | The Lead, with its owner. |
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
import { $ } from 'startup-builder'
const lead = await $.Lead.assign({ lead: 'lead_Kz1R9fhqzZ' })Lead.convert
Convert ends a qualified Lead’s pursuit as a Lead: it opens a Deal or routes the Lead to self-serve checkout. Verb page.
interface LeadVerbs {
convert(input: LeadConvertInput, options?: SB.CallOptions): SB.Call<LeadConvertOutput>
}Emits Lead.converted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
lead | Lead | required | The qualified Lead. |
offer | Offer | required | The Offer the Deal pursues, or the checkout sells. |
route | string | required | Where the Lead goes: deal for an assisted sale or checkout for self-serve. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
deal | Deal | The opened Deal, when the route is deal. | |
lead | Lead | required | The Lead, now converted. |
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
import { $ } from 'startup-builder'
const { deal, lead } = await $.Lead.convert({ lead: 'lead_Kz1R9fhqzZ', offer: 'offer_2hzYe1ERo0', route: 'Example route' })Lead.disqualify
Disqualify ends a Lead’s pursuit because it fits no Offer, with the reason; its Contact record and Consent stay. Verb page.
interface LeadVerbs {
disqualify(input: LeadDisqualifyInput, options?: SB.CallOptions): SB.Call<Lead>
}Emits Lead.disqualified.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
lead | Lead | required | The Lead to disqualify. |
reason | string | required | Why it fits no Offer. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
lead | Lead | required | The Lead, now disqualified. |
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
import { $ } from 'startup-builder'
const lead = await $.Lead.disqualify({ lead: 'lead_Kz1R9fhqzZ', reason: 'noFit' })