Skip to main content
Use Echtpost through Corsair: one client, typed API calls, local DB sync. Create an API key in the EchtPost web app under Account > API keys; the plugin sends it in the X-Api-Key header. A key starting ep_live_ sends real cards. A key starting ep_test_ is a sandbox key: its cards, contacts and groups are stored apart and are never printed or billed, so use one while building. Things to know:
  • Creating a card sends a postcard and costs money. cards.create and cards.createFromTemplate print and post a card to every recipient and bill the account per card, so they are destructive; with a permissions mode such as permissions: { mode: 'cautious' } they wait for approval. Check account.credits first.
  • Recipients. Pass saved contacts in recipient_ids, whole groups in group_ids, or new postal addresses in recipients. {anrede} in the text becomes each recipient’s salutation (see greeting_style on a contact).
  • Motives. A motive is the front design. motives.get says which text fields it allows (content_available, content_ps_available, vertical_text_available); text the motive does not allow is refused with 422.
  • Check the text first. cards.previewFit says whether the text fits at a font and size, and suggests a size when it does not. It creates nothing.
  • Delivery. deliver_at takes YYYY-MM-DD, today, asap, tomorrow or N-days-from-now, at most 90 days out; weekends and printer holidays move to the next print date unless move_to_next_print_date is false.
  • Cancelling. cards.cancel works while the card is still cancelable; it runs asynchronously and cannot be undone.
  • Errors are RFC 7807 problem details; a failed call drops its request body (names, addresses) from the error. Events log ids only.
What you get:
  • 22 typed API operations
  • 1 synced entity (templates) for fast .search() / .list()

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

List scheduled cards
Add a recipient
See the full list on the API page.

Query synced data

Synced entities support tenant.echtpost.db.<entity>.search() and .list(): templates. See Database for filters and operators.

What’s next

API reference

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

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.