> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# PersistIQ plugin

> PersistIQ is an outbound sales automation platform. This plugin manages leads and their custom attributes, campaigns and their lead membership, replies to inbox messages, do-not-contact domains, activity events, tags, lead fields and statuses, and the webhook plugin settings.

Use **PersistIQ** through Corsair: one client, typed API calls.

Authenticate with the API key from the PersistIQ integrations settings (Settings > Integrations > API Key); the plugin sends it in the x-api-key header. List operations answer \{ status, errors, has\_more, next\_page } plus a named array (leads, campaigns, campaign\_leads, replies, events, ...). Pages are numbered: pass page: 2, 3, ... while has\_more is true.
Lead attributes live in a `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](https://persistiq.com/api-docs/v1/swagger.json)

**What you get:**

* 21 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/persistiq better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/persistiq better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/persistiq better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/persistiq better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { persistiq } from '@corsair-dev/persistiq';

export const corsair = createCorsair({
	plugins: [
		persistiq(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the PersistIQ API key before the first call: `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](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> persistiq()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**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](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'persistiq',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read a lead**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.persistiq.api.leads.get({ id: 'l_1' });
```

**Create a lead**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.persistiq.api.leads.create({
	lead: { email: 'john@example.com', first_name: 'John' },
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/persistiq/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/persistiq/api.md)
>
> Every `persistiq.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.