Heymail API
Mit der Heymail API automatisieren Sie den Versand personalisierter Postkarten nahtlos in Ihren bestehenden Systemen – perfekt für die Integration in CRM-Prozesse, Shop-Trigger, Lifecycle-Kampagnen oder eigene Marketing-Tools.
Was kann die Heymail API?
Die öffentliche REST API ist auf den Postkarten-Versand fokussiert. Sie können einzelne Postkarten versenden oder ganze Batches mit bis zu 10.000 Empfängern in einem einzigen Request auslösen.
Einzelversand
POST /mailings/send beauftragt eine einzelne personalisierte Postkarte – mit Template-ID, Empfängeradresse und optionalen Absender- und Versandangaben.
Batch-Versand
POST /mailings/send-batch verschickt bis zu 10.000 Empfänger in einem Request als ein gemeinsamer Auftrag – perfekt für Kampagnen aus CRM- oder Marketing-Automation-Systemen.
Personalisierung
Pro Empfänger können individuelle Variablen (variableData) mitgegeben werden – z. B. Namen, Gutscheincodes oder Parameter für personalisierte QR-Codes (bis 1.024 Zeichen pro Wert).
Vorschau
POST /mailings/preview erzeugt eine temporäre Vorschau-URL für eine Postkarte mit Ihren Daten – ohne Auftrag, ohne Druck, ohne Versand. Ideal für UI-Integrationen und Freigabe-Workflows.
Templates aus der Web-App
Postkarten-Templates werden bequem im Heymail-Editor gepflegt und per templateId referenziert. So bleibt das Design in der Hand von Marketing & Design, während Ihre Integration nur die Daten liefert.
Test- & Live-Keys
Zwei API-Key-Typen: hey_test_* für Entwicklung ohne kostenpflichtige Aufträge und hey_live_* für den produktiven Versand – damit können Sie Ihre Integration gefahrlos entwickeln und abnehmen.
API aktivieren
Der Zugang zur Heymail API wird individuell pro Account freigeschaltet. Sie erhalten von uns einen persönlichen API-Key, mit dem Ihre Anfragen authentifiziert werden.
- Heymail-Account anlegen – falls noch nicht vorhanden, registrieren Sie sich hier kostenlos.
- API-Zugang anfragen – nehmen Sie über unser Kontaktformular Kontakt mit uns auf und geben Sie kurz an, was Sie automatisieren möchten (z. B. Shop-Anbindung, CRM-Trigger, Kampagnen-Versand).
- API-Key erhalten – wir schalten den Zugang frei und senden Ihnen den API-Key zusammen mit einem kurzen Onboarding zu.
- Integration umsetzen – folgen Sie der API-Dokumentation für Endpunkte, Payloads und Beispiele.