Skip to main content
Use Superchat through Corsair: one client, typed API calls. Create an API token in Superchat under Settings, then API. You have to be an administrator to see it. Pass it as the plugin’s key option or store it on the account; the plugin sends it as the X-API-KEY header. Things to know before you write:
  • The API path carries v1.0, not v1. A request to /v1/contacts answers 405 Method Not Allowed, which reads like a routing bug rather than a wrong path. The plugin uses v1.0, as Superchat’s own examples do.
  • A missing key is 401 and a wrong key is 403. The 403 does not mean a scope is missing, so the plugin treats both as an auth failure.
  • Sending reaches a real person. messages.send delivers on WhatsApp, SMS, Instagram, Messenger, Telegram or email, depending on the from channel and the recipient’s handle. The content has to suit that channel: a channel that only accepts templates will reject a plain text body.
  • One recipient per message. The spec caps to at one entry, and the schema enforces it.
  • A contact needs a handle. A handle is the email address or phone number that identifies a contact on a channel, and at least one is required. Creating a contact with none would leave Superchat nothing to reach them on.
  • The contact update route requires three fields. contacts.update is a PATCH, but it lists first_name, last_name and gender as required, so a caller changing one sends the other two back. Their values may be null; the keys may not be absent.
  • Snoozing needs two fields. Set status: 'snoozed' together with a snoozed_until time, or leave snoozing alone. The schema rejects the mismatch.
  • Paging is by cursor. after takes the last id of the previous page and before reads backwards. Only one may be set, and limit is 1 to 100, defaulting to 50.
  • Rate limits. Each workspace gets 2500 requests per 5-minute window, shared across its API keys, and a trial workspace is capped at 10000 calls for its whole lifetime. Both answer 429, and the plugin retries three times with backoff.
What you get:
  • 22 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

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.

Example API calls

Read the messages in a conversation
Send a text message to one recipient
See the full list on the API page.

What’s next

API reference

Every superchat.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.