Skip to content

by Startups.Studio

Growth Contact Lead

Lead.convert

POST /{namespace}/leads/{lead}/convert

Convert ends a qualified Lead’s pursuit as a Lead: it opens a Deal or routes the Lead to self-serve checkout.

Noun: Lead
Mode: do
Event: Lead.converted

You, to your agent

Convert the latest lead with an offer.

curl -X POST https://api.sb/shiftnote.app/leads/lead_1/convert \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offer":"offer_1","route":"Example route"}'

import { $ } from 'startup-builder'

const { deal, lead } = await $.Lead.convert({ lead: 'lead_1', offer: 'offer_1', route: 'Example route' })

npx startup-builder do Lead.convert --json '{"lead":"lead_1","offer":"offer_1","route":"Example route"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Lead.convert({ lead: 'lead_1', offer: 'offer_1', route: 'Example route' })"
  }
}

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.

Outputs

Output	Type	Required	Description
`deal`	Deal		The opened Deal, when the route is `deal`.
`lead`	Lead	required	The Lead, now converted.

Effects

Emits Lead.converted.
Performed by the Sales Lead.
Two-way: it runs at once, in the try, send and do modes.
Moves the Lead to converted and keeps its Acquisition on the Deal and the later Customer.

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

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

Previous Page

Lead.create

Next Page