Skip to content

Lead.disqualify

Closes a lead that fits none of your offers, with the reason; its Contact and Consent stay.

Action class
None
Approval
Runs on its own
Emits
Lead.disqualified
Price
Free
POST https://api.sb/{your-domain}/leads/{lead}/disqualify

Its Inputs, Outputs, Effects and guards quote the hub’s Lead.disqualify; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of CRM.

Inputs

NameTypeDefaultMeaning
leadLeadRequiredThe lead to disqualify.
reasonstringRequiredWhy it fits no offer.

Outputs

FieldTypeWhat null means
leadLeadNever null: the lead, now disqualified.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Lead.disqualified fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

The lead fit Policy reads the reason when it grades the next lead.

Emits

Lead.disqualified with { lead }

Performed by

Sales lead

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Lead.disqualified delivers the result.

You, to your agent
Disqualify the lead from the single-family landlord with 2 units: too
small for us.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Lead.disqualify",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

None.