Overview

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

• 25 typed API operations

​

Setup

npm install corsair @corsair-dev/emailoctopus

yarn add corsair @corsair-dev/emailoctopus

pnpm install corsair @corsair-dev/emailoctopus

bun add corsair @corsair-dev/emailoctopus

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!,
	},
});

emailoctopus()

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

​

Example API calls

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

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

​

What’s next