prospect
Prospects are individual contacts in the CRM, organized by lists, tags, and campaign participation. The full prospect field schema (including the 36-value sendingStatus enum and BounceHard/BounceSoft caveat) lives in schemas/prospect. Looking for prospects you just added? prospect/get pages oldest-first with no recency sort — see its "find your newest prospects" recipe.
Bounce or list-hygiene question ("who bounced?", "is my list clean?")? Scan the whole account with prospect/get's sendingStatus filter (e.g. BounceHard) — not just the latest import, and not a question to hand back to the user.
Operations
Read
- prospect/get — list prospects with optional filtering
- prospect/get_by_id — fetch a single prospect
- prospect/get_tags_by_id — list tags on a prospect
Receive
- prospect/messages_by_id — email message history
Create
- prospect/post — create a single prospect
- prospect/post_bulk — bulk-upsert prospects and enrol them into a campaign (
campaignId); merges onto existing rows — omitted fields are preserved, not cleared - prospect/post_tags_by_id — add a tag to a prospect
Update
- prospect/patch_by_id — partially update a prospect
Delete
- prospect/delete_by_id — permanently delete a prospect
- prospect/delete_by_id_tags_by_tagId — remove a tag from a prospect