Integration guides, API reference, and best practices for sending email from your frontend.
Getting started
What MailingCore is, who it's for, and how it fits in your stack.
Tenant, API keys, scopes, templates, and other product terminology.
Send your first email with an API key in under 10 minutes.
Send transactional email when a Botpress support flow opens a helpdesk incident.
How MailingCore fits in your stack — browser SDK, server API, and queues.
Production API URL, mc_live vs mc_test keys, and staging.
Verify domain, quota, and suppressions before going to production.
JavaScript SDK
mailingcore-js — init, send, and error handling.
Install mailingcore-js — npm package and publication status.
MailingCore.init — apiKey, baseUrl, and timeout options.
Use templateVersionId to send published template versions.
Safe retries with idempotencyKey — duplicate sends return the same response.
MailingCoreError — status codes, detail messages, and recovery.
Server Actions and Route Handlers — keep API keys off the client.
REST API
JWT for the dashboard and API keys for integrations.
Create keys, assign permissions, and rotate credentials.
X-Tenant-Id header and data isolation.
POST /emails/send — payload, response, and templates.
HTTP error format and common causes.
X-Quota headers, grace period, and blocking.
POST /emails/batch — up to 100 recipients with per-recipient variables.
GET /emails/logs — paginated send history for your tenant.
Request throttling, auth limits, and X-RateLimit-* response headers.
POST/GET/DELETE /scheduled-emails — defer transactional sends.
Templates
Draft vs Published versions and sending with templateVersionId.
POST .../publish, inline CSS, and unpublish.
{{var}} syntax, unsubscribeUrl, and declared variables.
GET /library and POST clone — system templates for your tenant.
Dashboard editor — Monaco, Unlayer blocks, and draft versions.
locale and localeGroupId — multi-language template versions.
Deliverability
Why to verify your domain before production.
SPF, DKIM, and DMARC records generated by MailingCore.
Check SPF, DKIM, and DMARC after configuring DNS.
Block sends to bounced, complained, or unsubscribed addresses.
Tracking pixel and link redirect endpoints for engagement metrics.
fromEmail, fromName, and replyTo — sender identity on verified domains.
Hard bounce suppression, SES webhooks, and email.bounced events.
Newsletter & audience
Contact model, externalId, locale, and opt-in for newsletter sends.
PUT /contacts — upsert by email or externalId.
POST /contacts/bulk — upsert up to 1000 contacts per request.
Public unsubscribe page, {{unsubscribeUrl}}, and contact.unsubscribed webhooks.
Newsletter campaigns, audience filters, fan-out, and lifecycle states.
Draft → test → schedule or send → cancel.
GET /campaigns/{id}/locale-coverage — audience counts per language.
Contacts sync, campaigns API, and bidirectional webhooks for embedded newsletter.
Webhooks
Events, endpoint registration, and retries.
Validate X-MailingCore-Signature on your server.
Payload reference for email.* and contact.unsubscribed events.
Register POST /webhooks/endpoints with webhooks:manage scope.
Delivery log, BullMQ retry policy, and idempotent handling.
Plans & limits
Per-plan limits, quotas, and Stripe billing.
80% warning, 110% grace period, and 429 blocking.
Stripe Checkout for plan changes and Customer Portal for payment management.
Monthly grants, one-time token packs, and consumption on /ai endpoints.
Security & GDPR
European hosting, GDPR positioning, and data boundaries.
DELETE /contacts/:externalId — right to be forgotten.
Rotation, environment separation, and no client exposure.
Dashboard
Tour of the MailingCore web panel: emails, templates, domains, and settings.
Create, copy, and scope API keys from the dashboard.
Enable TOTP 2FA for dashboard admins.
Invite admins, assign roles, and manage tenant membership.
Summary KPIs, daily trends, and top templates from the dashboard and API.
Reference
Interactive Swagger UI and machine-readable schema at api.mailingcore.com.
Abbreviated public glossary of MailingCore terms.
Common questions about MailingCore maturity, hosting, and SDK availability.
Documentation releases and high-level product milestones.