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

# Overview

> EmailOctopus lists, contacts, tags, custom fields, campaigns and automations on API v2.

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

Create an API key under EmailOctopus account settings, Developer, API keys. A key created before API v2 (labelled legacy) will not authenticate. The key is sent as `Authorization: Bearer`.

* **Deletes are permanent.** `lists.delete`, `contacts.delete`, `fields.delete` and `tags.delete` remove the resource.
* **Create versus upsert.** `contacts.create` fails when the email is already on the list. `contacts.upsert` updates that contact instead.
* **Tag updates on a contact.** `contacts.create` takes `tags` as an array of names. `contacts.upsert` and `contacts.update` take `tags` as `{ tagName: true | false }`.
* **Rate limits.** The account has a bucket of 100 requests, refilled at 10 per second. A 429 includes `X-RateLimit-Retry-After`. The plugin retries that up to three times. Writes are not retried on 5xx.
* **Paging.** Collection calls return `paging.next.starting_after`. Pass that cursor back as `starting_after`. `limit` is at most 100.
* **Webhooks.** This plugin does not receive webhooks.

**What you get:**

* 25 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/emailoctopus
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/emailoctopus
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/emailoctopus
```

```bash bun theme={null}
bun add corsair @corsair-dev/emailoctopus
```

**2. Add the plugin**

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

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

Multi-tenancy is the default — 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)
>
> No setup call is required to register the plugin. A request with no saved key throws `AuthMissingError`. When a connect link can be minted, that error includes `connectUrl`. Redirect the tenant to `connectUrl`, or show `error.message`.
>
> ```ts theme={null}
> emailoctopus()
> ```
>
> 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: 'emailoctopus',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List the first page of lists**

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

**Add a contact to a list**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.emailoctopus.api.contacts.create({ list_id: '00000000-0000-0000-0000-000000000000', email_address: 'otto@example.com' });
```

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

## What's next

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