Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthContactLead

Lead routes: assign, convert, disqualify

The Lead Verbs assign, convert, disqualify as api.sb routes, with inputs, result, refusals and an example.

Reference for Lead, one group of Lead routes.

Lead.assign

Assign gives a Lead one owner Worker, by round robin, territory or ICP fit, as the Startup’s routing Policy says. Verb page.

Text
POST /{namespace}/leads/{lead}/assign

Path: lead. Body, as JSON: the other inputs. Emits Lead.assigned.

Inputs

InputTypeRequiredDescription
leadLeadrequiredThe Lead to route.
ownerWorkerThe Worker to own it; omitted, the routing Policy picks.

Returns

OutputTypeRequiredDescription
leadLeadrequiredThe Lead, with its owner.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ/assign \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "lead": {
    "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
    "$type": "Lead",
    "status": "new"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Lead.assign",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Lead.convert

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

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

Path: lead. Body, as JSON: the other inputs. Emits Lead.converted.

Inputs

InputTypeRequiredDescription
leadLeadrequiredThe qualified Lead.
offerOfferrequiredThe Offer the Deal pursues, or the checkout sells.
routestringrequiredWhere the Lead goes: deal for an assisted sale or checkout for self-serve.

Returns

OutputTypeRequiredDescription
dealDealThe opened Deal, when the route is deal.
leadLeadrequiredThe Lead, now converted.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ/convert \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offer":"offer_2hzYe1ERo0","route":"Example route"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "deal": {
    "$id": "https://api.sb/leaseline.app/deals/deal_NgACZ6DcII",
    "$type": "Deal",
    "status": "Open"
  },
  "lead": {
    "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
    "$type": "Lead",
    "status": "converted"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Lead.convert",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Lead.disqualify

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

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

Path: lead. Body, as JSON: the other inputs. Emits Lead.disqualified.

Inputs

InputTypeRequiredDescription
leadLeadrequiredThe Lead to disqualify.
reasonstringrequiredWhy it fits no Offer.

Returns

OutputTypeRequiredDescription
leadLeadrequiredThe Lead, now disqualified.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ/disqualify \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"noFit"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "lead": {
    "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
    "$type": "Lead",
    "status": "disqualified"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Lead.disqualify",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

nurture, qualify

Next