> ## 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.

# Lemlist plugin

> Sales engagement and cold email outreach platform for automating multi-channel campaigns, lead tracking, deliverability, and unsubscribes.

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

Lemlist uses HTTP Basic authentication. Provide your Lemlist API key from your team settings (`Settings` -> `Integrations` -> `API`).
The API key is passed as the password with an empty username (`Authorization: Basic base64(:apiKey)`).

Things to know before calling:

* **Identifiers:** Campaign IDs and Lead IDs follow Lemlist's internal identifier format (e.g., `cam_...`, `lea_...`).
* **Rate Limiting:** Lemlist enforces API rate limits. The plugin automatically handles HTTP 429 responses and backs off according to the `Retry-After` header.
* **Campaign Lead Actions:** `leads.pause` and `leads.resume` act on every campaign unless you pass `campaignId`. Interest changes have separate global (`leads.markInterested`) and campaign (`leads.markInterestedInCampaign`) operations. Step operations (`leads.personalizeStep`, `leads.skipStep`) always need a campaign.
* **Unsubscribes & Blacklist:** Contacts can be unsubscribed or resubscribed either by variable (such as `email` or `domain`) or via the contact management endpoints.

**What you get:**

* 60 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/lemlist 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 { lemlist } from '@corsair-dev/lemlist';

export const corsair = createCorsair({
	plugins: [
		lemlist(),
	],
	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 Lemlist API key before the first call: `pnpm corsair setup --plugin=lemlist --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}
> lemlist()
> ```
>
> 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: 'lemlist',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List campaigns**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.lemlist.api.campaigns.list({ limit: 10 });
```

**Add a lead to an outreach campaign**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.lemlist.api.leads.createInCampaign({
	campaignId: 'cam_1234567890abcdef',
	email: 'contact@example.com',
	firstName: 'Jane',
	lastName: 'Doe',
});
```

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

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/lemlist/api.md)
>
> Every `lemlist.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.