Prospect methods: engage
The Prospect Verbs engage as typed SDK methods, with inputs, result, refusals and an example.
Reference for Prospect, one group of Prospect methods.
Prospect.engage
Engage records a Prospect’s first reply or raised hand and makes it a Lead that keeps its Acquisition. Verb page.
interface ProspectVerbs {
engage(input: ProspectEngageInput, options?: SB.CallOptions): SB.Call<ProspectEngageOutput>
}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
import { $ } from 'startup-builder'
const { lead, prospect } = await $.Prospect.engage({ prospect: 'prospect_S8bqJCxC9R' })