Lead.convert · SalesBuilder

POST https://api.sb/{your-domain}/leads/{lead}/convert

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

Inputs

Name	Type	Default	Meaning
`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

Field	Type	What `null` means
`deal`	`Deal`	The opened deal, when the route is `deal`. Absent when it does not apply.
`lead`	`Lead`	Never null: the lead, now converted.

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

Moves the lead to converted and keeps its Acquisition on the deal and the later customer.

Emits

Lead.converted 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.converted delivers the result.

You, to your agent

Maria wants the annual plan: open the deal on the Portfolio offer.

Response, in send mode

{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Lead.convert",
    "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.

InputsCopy Anchor Link

OutputsCopy Anchor Link

EffectsCopy Anchor Link

On each VenueCopy Anchor Link

What try doesCopy Anchor Link

Refuses whenCopy Anchor Link

When it waitsCopy Anchor Link

ExampleCopy Anchor Link

Used byCopy Anchor Link

RelatedCopy Anchor Link