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

# Thanks.io plugin

> Manage direct-mail recipients, mailing lists, orders, creatives, and webhook destinations with Thanks.io.

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

Thanks.io uses bearer API keys. An email-only recipient may trigger paid address lookup. Direct mail sends and radius purchases can incur charges. Requests are not retried automatically.

The bulk recipient example uses `mailing_list`, while the published schema uses `mailing_list_id`; both are accepted and forwarded unchanged. Bulk results may contain an `error` for an individual recipient.

Webhook destination operations manage Thanks.io's outbound subscriptions; inbound webhook verification is not included.

Deleting a sub-account also deletes its image templates, message templates, and campaigns; its orders and mailing lists move to the main account.

Replaying an order creates and charges for a fresh mailing. Invalidating an unredeemed gift card is irreversible.

Send operations can create paid mailings. Use `preview: true` to request previews or the corresponding `estimate` endpoint to price a mailing before submitting. Email-to-address and radius lookup may incur additional charges.

`imageBuilder.create` returns the PNG as `{ contentType, base64 }`; it does not place an order.

**What you get:**

* 52 typed API operations

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**`creatives.get`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.thanksio.api.creatives.get({ creativeId: 501 });
```

**`recipients.create`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.thanksio.api.recipients.create({
	body: { mailing_list_id: 1, email: 'person@example.com' },
});
```

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

## What's next

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