Skip to content
SalesBuilder
Code
See my plan

Prospect.engage

Records a Prospect’s first reply or raised hand and makes them a lead that keeps where they came from.

Action class
None
Approval
Runs on its own
Emits
Prospect.engaged
Venues
Gmail
Price
Free
More factsFewer facts
POST https://api.sb/{your-domain}/prospects/{prospect}/engage

Its Inputs, Outputs, Effects and guards quote the hub’s Prospect.engage; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Prospecting.

Inputs

NameTypeMeaning
prospectProspectRequired. The Prospect that replied or raised a hand.
messageMessageThe reply or Form submission that shows the engagement. Optional.

Outputs

FieldTypeWhat null means
leadLeadNever null: the new lead, with status new and the Prospect’s Acquisition.
prospectProspectNever null: the Prospect who engaged.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Prospect.engaged fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

Ends outreach to the Prospect: no further Sequence step sends. Links the lead to the Prospect’s Acquisition.

Emits

Prospect.engaged with { prospect }

Performed by

Prospector

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

VenueFormats
GmailNone.

Each Venue’s caps, review and rate limits are on its integration page, linked from its row. A field marked Not sent is one that Venue has no place for; the call never fails on it.

What try does

AccountWhat try does
GmailRenders the exact email, headers included, and returns it with the time it would send; nothing reaches Gmail and no draft is saved.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

Through a connected account it can also meet the shared account refusals.

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Prospect.engaged delivers the result.

You, to your agent
Maria replied to the first email: make her a lead.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Prospect.engage",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

Prospecting

Previous

Prospect.create

Next