Skip to content

by Startups.Studio

Growth Contact Lead

Lead.qualify

POST /{namespace}/leads/{lead}/qualify

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

Noun: Lead
Mode: do
Event: Lead.qualified

You, to your agent

Qualify the latest lead with an offer.

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

import { $ } from 'startup-builder'

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

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

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

Inputs

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

Outputs

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

Effects

Emits Lead.qualified.
Performed by the Sales Engineer.

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.qualify
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.	Lead.qualify

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

Previous Page

Lead.update

Next Page