Prospect routes: engage · StartupBuilder

Reference for Prospect, one group of Prospect routes.

Prospect.engage

Engage records a Prospect’s first reply or raised hand and makes it a Lead that keeps its Acquisition. Verb page.

Text

POST /{namespace}/prospects/{prospect}/engage

Path: prospect. Body, as JSON: the other inputs. Emits Prospect.engaged.

Inputs

Input	Type	Required	Description
`prospect`	Prospect	required	The Prospect that replied or raised a hand.
`message`	Message		The reply or Form submission that shows the engagement.

Returns

Output	Type	Required	Description
`lead`	Lead	required	The new Lead, with status `new` and the Prospect’s Acquisition.
`prospect`	Prospect	required	The Prospect who engaged.

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

Example

Terminal

curl -X POST https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R/engage \
  -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"
  },
  "prospect": {
    "$id": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R",
    "$type": "Prospect",
    "foundIn": "Example found in",
    "basis": "Example basis"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Prospect.engage",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Prospect.engageCopy Anchor Link

Prospect.engage