Skip to content

by Startups.Studio

Growth Contact Lead

Lead.disqualify

POST /{namespace}/leads/{lead}/disqualify

Disqualify ends a Lead’s pursuit because it fits no Offer, with the reason; its Contact record and Consent stay.

Noun: Lead
Mode: do
Event: Lead.disqualified

You, to your agent

Disqualify the latest lead.

curl -X POST https://api.sb/patentpad.com/leads/lead_1/disqualify \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"noFit"}'

import { $ } from 'startup-builder'

const lead = await $.Lead.disqualify({ lead: 'lead_1', reason: 'noFit' })

npx startup-builder do Lead.disqualify --json '{"lead":"lead_1","reason":"noFit"}'

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

Inputs

Input	Type	Required	Description
`lead`	Lead	required	The Lead to disqualify.
`reason`	`string`	required	Why it fits no Offer.

Outputs

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

Effects

Emits Lead.disqualified.
Performed by the Sales Lead.
Two-way: it runs at once, in the try, send and do modes.
The Lead fit Policy reads the reason when it grades the next Lead.

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

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

Previous Page

Lead.get

Next Page