Update Prospect
update_prospectSet priority=True to push this person's queued sends — email and LinkedIn alike —
ahead of everyone else's; it's account-wide and durable, carrying across the sequence's
later steps for this person. priority=False clears it. One priority flag per prospect,
independent of channel: both channels' derived send order reads it.
Most stage transitions — sent, connected, messaged, replied — stamp
automatically from send and reply detection; don't set those by hand. The three
reply-outcome rungs above replied — interested/meeting_booked (positive) and
not_interested (an explicit decline) — normally stamp from the reply classifier
too, so set one by hand only to fix a wrong call or record an off-platform outcome:
stage='interested' for clear interest, stage='meeting_booked' when they agree to or
book a meeting, stage='not_interested' when they've declined. The mark only raises a
rung — a decline can't override a live positive (to lower a false
meeting_booked/interested, correct that reply with correct_reply_outcome) — and it
counts the person as replied, so to drop someone who never engaged use stage='skipped'.
Setting a reply-outcome rung also cancels the person's still-pending queued outreach
on both channels — automation stops; messages you queue afterwards still send.
A later positive reply lifts not_interested back up on its own.
When you set stage='skipped', pass skip_note with the reason in a few words, so a later reader knows why this person was dropped without digging up the chat — a bare skip records no reason.
To reverse a skip and put the person back in the funnel, set stage to the rung they should resume at — normally stage='pending' to re-queue them from the top. That re-enters them into outreach (a still-skipped prospect is held out of every send) and clears the stale skip note; their flow position is preserved, so the sequence resumes from where they were rather than restarting a step already taken.
To store an address you found for a prospect that reached an email step without
one (recovering an email_not_found block), pass email; the stamped address makes
the step send when you retry it. For a blocked prospect,
retry_blocked_enactment(email=...) stamps and retries in one call instead.
To undo an accidental hand-set mark (e.g. a prospect wrongly marked meeting_booked),
pass clear_manual_mark=True on channel — it removes the mark and re-derives the
stage from actual send/reply activity, the only way to lower past a manual mark (which
the mark path deliberately floors demotions at). This differs from correct_reply_outcome,
which re-judges a specific reply; use clear_manual_mark when the wrong rung came from a
hand mark, not a misjudged reply. Pass it on its own (no stage/data/priority/email).
Dict with the updated item details. After a skip, skip_outcome says how many
queued sends were cancelled and lists any that had already gone out — a skip
can't undo those, so tell the user about them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | An address to store for this prospect (optional). Fills in a prospect that reached an email step without one, so a retried step can send. Lands on the person's profile, the prospect's only address, overwriting an existing one — so it also changes the address any teammate's campaign for this person sends to. Refused if the address already belongs to another person in the workspace (likely the same person under two records). Leave unset for ordinary stage/priority updates. | ||
| stage | No | New stage value (optional) — e.g. 'skipped' to drop the person, 'pending' to reverse a skip and re-queue them. | |
| channel | Yes | 'linkedin' or 'email' — which funnel the update applies to: the stage column `stage` sets, the manual mark `clear_manual_mark` removes, and the queued sends a skip cancels. | |
| agent_id | Yes | ID of the agent | |
| priority | No | True to prioritize this prospect's queued sends (email and LinkedIn) over everyone else's; False to clear. Account-wide and channel-independent (optional). | |
| skip_note | No | Short free-text reason for a skip, e.g. "off-industry — gold mining, not supplements" (optional). Recorded only when stage='skipped'; ignored otherwise. | |
| prospect_id | Yes | The prospect's `id` — the outreach_prospects primary key, as returned on every query_prospects row and shown on the flow roster line. | |
| data_updates | No | Dict to merge into existing data (optional) | |
| linkedin_url | No | A corrected or missing LinkedIn profile URL/slug to bind to THIS prospect in place (optional) — an unverified claim the next send verifies through the profile resolver; any prior verification of the old URL is cleared with it. Refused when the URL already belongs to another of the user's prospects, or when a teammate's prospect verified the same person. | |
| on_behalf_of | No | An agency client's email, from list_agency_clients, to run this call in that client's account: their agents, settings, connected accounts, and credits. Omit it to act on your own account. | |
| clear_manual_mark | No | True to remove this channel's hand-set reply-outcome mark and re-derive the stage from send/reply activity — the undo for an accidental mark. Pass it alone; combining with stage/data_updates/priority/email is refused. |