prospect
Skip, close, or dismiss a lead in an outreach campaign. Record won, lost, or opt-out outcomes with reasons.
Instructions
Skip a prospect, close one with an outcome, or dismiss it.
Someone who is not a fit is skipped, not closed: skip leaves them out of
this campaign and records nothing else. Close records a result and
needs an outcome; won and lost are for people HeyLead has written to.
Closing with outcome="opt_out" stops all future contact with that person.
Reading a prospect is prospect_view.
Args:
action: "skip", "close" or "dismiss".
outreach_id: Which outreach.
campaign_id: Which campaign. Uses the active one if empty.
outcome: "won", "lost" or "opt_out". Required for close; there is
no default.
reason: Why, recorded with the outcome.
meeting_link: The booked meeting, recorded with a won outcome.
confirm: Required where the action cannot be undone.
reason_code: Why, for skip and close: "not_a_fit", "negative_reply",
"asked_to_stop", "handled_elsewhere" or "other".
reason_note: A free note alongside the code.
deal_value: What the won deal is worth (close with outcome="won").
deal_currency: Three-letter code, e.g. USD. Defaults to the last deal's.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | ||
| reason | No | ||
| confirm | No | ||
| outcome | No | ||
| deal_value | No | ||
| campaign_id | No | ||
| outreach_id | No | ||
| reason_code | No | ||
| reason_note | No | ||
| meeting_link | No | ||
| deal_currency | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |