Prospect programs: engage · StartupBuilder

Reference for Prospect, one group of Prospect programs.

Prospect.engage

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

Text

do: return await $.Prospect.engage(input)

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

JSON

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