Skip to content

by Startups.Studio

Growth Prospect

Prospect.engage

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

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

Noun: Prospect
Mode: do
Event: Prospect.engaged

You, to your agent

Engage the prospect Priya Natarajan.

curl -X POST https://api.sb/ledgerlark.com/prospects/prospect_1/engage \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { lead, prospect } = await $.Prospect.engage({ prospect: 'prospect_1' })

npx startup-builder do Prospect.engage --json '{"prospect":"prospect_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Prospect.engage({ prospect: 'prospect_1' })"
  }
}

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.

Outputs

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.

Effects

Emits Prospect.engaged.
Performed by the Prospector.
Two-way: it runs at once, in the try, send and do modes.
Ends outreach to the Prospect: no further Sequence step sends.
Links the Lead to the Prospect’s Acquisition.

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.	Prospect.engage

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

Prospect.delete

Previous Page

Prospect.get

Next Page