Prospect
Saves a person you found as a Prospect, with where you found them and the basis to write to them.
- Action class
- None
- Approval
- Runs on its own
- Emits
Prospect.created- Price
- Free
It extends the hub’s record call Prospect.create, which every Prospect takes. It is one of the Verbs of Prospecting.
Inputs
| Name | Type | Default | Meaning |
|---|---|---|---|
foundIn | string | Required | Where the startup found them. |
basis | string | Required | The recorded reason you may contact them. |
acquisition | Acquisition | None. | A Prospect’s Acquisition names the outbound Play and Mailbox that first reached it. Optional. |
The hub inherits this call on every Noun: it takes the Prospect’s own Properties, listed on the hub’s Prospect page.
Outputs
| Field | Type | What null means |
|---|---|---|
prospect | Prospect | Never null: the Prospect as the call leaves it. |
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.createdfires when it is done.do: Waits for the Action to finish and returns the record.
- Idempotency
Only with a key: the same
Idempotency-Keyand input return the first Action, and the same key with other input returns409.- Saved or shared
The Prospect is saved as the call leaves it, with the Action that changed it.
- Emits
Prospect.createdwith{ prospect }- Performed by
Whichever seat calls it
- Price
Free on your own account: the platform charges nothing for the call.
On each Venue
It acts on your own records and reaches no Venue, so every account answers the same way.
What try does
Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.
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).
When it waits
Returns in one response; nothing waits.
Example
In send mode the call returns its pending Action at once, and Prospect.created delivers the result.
Save Rosa Alvarez at Northgate Rentals as a prospect: she posted a
leasing coordinator role.{
"mode": "send",
"action": {
"$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w" ,
"operation": "Prospect.create",
"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
None.