Scopes
Add leads
Add 1-100 leads in one call. Each is deduplicated by email within the campaign and provider-detected. The response summarizes the outcome and returns the leads that were created.Response
List and filter
Cursor-paginated, newest-first, and stable under concurrent inserts/deletes - the right shape for syncing leads to a CRM (offset pages would skip or duplicate rows as leads change).Response
status, tags, search (email / name / company), or engagement. Keep requesting
with ?cursor=meta.nextCursor until meta.hasMore is false (then nextCursor
is null). limit defaults to 50 (max 250).
Engagement
Every lead carries its engagement, counted once per email:
Automated opens and clicks by security scanners and link prefetchers are excluded.
Opens are approximate by nature: Apple Mail and some security gateways load images
on their own, while clients that block images can hide opens.
?engagement= narrows the list:
Engagement reaches the lead within about a minute of the open or click.
Get one lead
Returns the lead plus live sequence progress (steps sent/planned, next send).Update a lead
Changing a lead’s email safely re-runs the add / dedup / provider-detect
pipeline, and is only allowed while the lead has not been contacted.
Bulk mutate
One operation over an id list -set_status, add_tags, remove_tags, or
delete. delete also accepts a filter instead of ids.