data map keyed by the account’s lead fields (read them with leadFields.list); leads.create takes them in lead. Adding a lead to a campaign (campaigns.addLead) starts the campaign’s automated emails to that lead, so it is marked destructive like a send (permission modes that pause destructive calls ask before it runs).
PersistIQ delivers outbound webhooks through its webhook plugin; the plugin reads and updates those settings (webhooks.getSettings and webhooks.updateSettings). The delivery signature scheme is not documented, so this plugin does not receive the deliveries.
Every operation is described in the official OpenAPI spec: https://persistiq.com/api-docs/v1/swagger.json
What you get:
- 21 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the PersistIQ API key before the first call: More: API Key
pnpm corsair setup --plugin=persistiq --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
Read a leadWhat’s next
API reference
Every
persistiq.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.