Orienting first
The authoritative, up-to-date endpoint reference is the PersistIQ API documentation (linked from the Integrations page). This article covers the shape of the API so you can plan an integration.
The resources you'll use most
- Prospects — create, read, update prospects; set custom field values; manage snippets.
- Campaigns — list campaigns and their structure.
- Campaign membership — add prospects to campaigns (the programmatic path to "start outreach on this list").
- Users / mailbox context — who owns what, for routing logic.
Typical integration patterns
- Lead router: form/tool → create prospect via API → add to campaign → follow-ups run.
- List sync: data warehouse → nightly job → upsert prospects → attach to campaign.
- Status mirror: webhook events → write outreach status back to your system of record.
Rules of the road
- Respect rate limits — batch operations where the API allows, back off on errors.
- Make writes idempotent (check-before-create by email) — retries shouldn't duplicate prospects.
- Don't add opted-out or bounced prospects to campaigns via API; the triggers will stop them, but you're wasting sends.
[CONFIRM: exact endpoint list, parameters, and rate limits from the current API docs]