Referenz
Alle Endpunkte
Alle Endpunkte der Emailit API v2 an einem Ort, nach Ressource gruppiert, mit HTTP-Methode, Pfad, benötigtem Scope des API-Schlüssels und Link zur Referenz.
Diese Seite listet alle Endpunkte der Emailit-API auf, nach Ressource gruppiert. Pfade sind relativ zur Basis-URL https://api.emailit.com/v2, und {id} steht für die ID des Objekts (oder, wo der Endpunkt es erlaubt, für seinen Namen oder seine E-Mail-Adresse).
Die Spalte Scope zeigt, welche API-Schlüssel den Endpunkt aufrufen können:
| Scope | Funktioniert mit |
|---|---|
sending |
Schlüsseln mit dem Scope sending oder full. |
events |
Schlüsseln mit dem Scope events oder full. |
full |
Nur Schlüsseln mit dem Scope full. |
Für OAuth-Zugriffstoken gelten dieselben Regeln wie für API-Schlüssel mit demselben Scope. OAuth hat keinen Scope events, daher benötigen Token für diese Endpunkte full.
E-Mails
E-Mails senden, Nachrichten und ihren Inhalt abrufen sowie E-Mails planen, stornieren, erneut senden oder weiterleiten. Die vollständige Referenz finden Sie unter E-Mails.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| E-Mail senden | POST |
/emails |
sending |
| E-Mails auflisten | GET |
/emails |
full |
| E-Mail abrufen | GET |
/emails/{id} |
full |
| Roh-MIME abrufen | GET |
/emails/{id}/raw |
full |
| Anhänge auflisten | GET |
/emails/{id}/attachments |
full |
| Body abrufen | GET |
/emails/{id}/body |
full |
| Metadaten abrufen | GET |
/emails/{id}/meta |
full |
| Geplante E-Mail aktualisieren | POST |
/emails/{id} |
sending |
| E-Mail stornieren | POST |
/emails/{id}/cancel |
sending |
| E-Mail erneut senden | POST |
/emails/{id}/retry |
sending |
| E-Mail weiterleiten | POST |
/emails/{id}/forward |
sending |
| Nur den Status abrufen | GET |
/email/{id} |
full |
Domains
Versanddomains hinzufügen, ihre DNS-Einträge und ihren Verifizierungsstatus abrufen und sie verifizieren. Die vollständige Referenz finden Sie unter Domains.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Domain erstellen | POST |
/domains |
full |
| Domain abrufen | GET |
/domains/{id} |
full |
| Domain verifizieren | POST |
/domains/{id}/verify |
full |
| Domain aktualisieren | POST |
/domains/{id} |
full |
| Domains auflisten | GET |
/domains |
full |
| Domain löschen | DELETE |
/domains/{id} |
full |
DMARC-Berichte
Aggregierte und forensische DMARC-Berichte einer Versanddomain abrufen oder eigene Berichte hochladen. Die vollständige Referenz finden Sie unter DMARC-Berichte.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Aggregierte Berichte auflisten | GET |
/domains/{id}/dmarc/reports |
full |
| Bericht abrufen | GET |
/domains/{id}/dmarc/reports/{report_id} |
full |
| Bericht hochladen | POST |
/domains/{id}/dmarc/reports |
full |
| Forensische Berichte auflisten | GET |
/domains/{id}/dmarc/forensic |
full |
| Forensischen Bericht abrufen | GET |
/domains/{id}/dmarc/forensic/{report_id} |
full |
| Statistiken abrufen | GET |
/domains/{id}/dmarc/stats |
full |
| Versandquellen auflisten | GET |
/domains/{id}/dmarc/sources |
full |
| Länder auflisten | GET |
/domains/{id}/dmarc/countries |
full |
| Netzwerke (ASNs) auflisten | GET |
/domains/{id}/dmarc/asns |
full |
| Berichtersteller auflisten | GET |
/domains/{id}/dmarc/reporters |
full |
API-Schlüssel
API-Schlüssel eines Workspaces erstellen, auflisten, umbenennen und widerrufen. Die vollständige Referenz finden Sie unter API-Schlüssel.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| API-Schlüssel erstellen | POST |
/api-keys |
full |
| API-Schlüssel abrufen | GET |
/api-keys/{id} |
full |
| API-Schlüssel auflisten | GET |
/api-keys |
full |
| API-Schlüssel aktualisieren | POST |
/api-keys/{id} |
full |
| API-Schlüssel neu generieren | POST |
/api-keys/{id}/regenerate |
full |
| API-Schlüssel löschen | DELETE |
/api-keys/{id} |
full |
Kontaktlisten
Abonnentenlisten verwalten, die Kampagnen und Anmeldeformulare nutzen. Die vollständige Referenz finden Sie unter Kontaktlisten.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Kontaktliste erstellen | POST |
/audiences |
full |
| Kontaktliste abrufen | GET |
/audiences/{id} |
full |
| Kontaktliste aktualisieren | POST |
/audiences/{id} |
full |
| Kontaktlisten auflisten | GET |
/audiences |
full |
| Kontaktliste löschen | DELETE |
/audiences/{id} |
full |
Abonnenten
Abonnenten einer Kontaktliste hinzufügen, aktualisieren und entfernen. Die vollständige Referenz finden Sie unter Abonnenten.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Abonnent hinzufügen | POST |
/audiences/{audience_id}/subscribers |
full |
| Abonnent abrufen | GET |
/audiences/{audience_id}/subscribers/{id} |
full |
| Abonnent aktualisieren | POST |
/audiences/{audience_id}/subscribers/{id} |
full |
| Abonnenten auflisten | GET |
/audiences/{audience_id}/subscribers |
full |
| Abonnent löschen | DELETE |
/audiences/{audience_id}/subscribers/{id} |
full |
Kontakte
Kontaktprofile und eigene Felder verwalten, einzeln oder gesammelt. Die vollständige Referenz finden Sie unter Kontakte.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Kontakt erstellen | POST |
/contacts |
full |
| Kontakt abrufen | GET |
/contacts/{id} |
full |
| Kontakt aktualisieren | POST |
/contacts/{id} |
full |
| Kontakte auflisten | GET |
/contacts |
full |
| Kontakte gesammelt aktualisieren | POST |
/contacts/bulk |
full |
| Kontakte exportieren | GET, POST |
/contacts/export |
full |
| Kontakt löschen | DELETE |
/contacts/{id} |
full |
Segmente
Filter über Ihre Kontakte speichern, die passenden Kontakte auflisten und Segmente mit Tracking über die Zeit verfolgen. Die vollständige Referenz finden Sie unter Segmente.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Segment erstellen | POST |
/segments |
full |
| Segment abrufen | GET |
/segments/{id} |
full |
| Segment aktualisieren | POST |
/segments/{id} |
full |
| Segmente auflisten | GET |
/segments |
full |
| Segment löschen | DELETE |
/segments/{id} |
full |
| Kontakte eines Segments auflisten | GET |
/segments/{id}/contacts |
full |
| Wachstum eines Segments abrufen | GET |
/segments/{id}/growth |
full |
| Segmentvorschau abrufen | POST |
/segments/preview |
full |
| Segmentfelder auflisten | GET |
/segments/fields |
full |
Kampagnen
Kampagnen erstellen, ihre Kontaktlisten und Segmente wählen und sie senden oder planen. Die vollständige Referenz finden Sie unter Kampagnen.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Kampagne erstellen | POST |
/campaigns |
full |
| Kampagne abrufen | GET |
/campaigns/{id} |
full |
| Kampagne aktualisieren | POST |
/campaigns/{id} |
full |
| Kampagnen auflisten | GET |
/campaigns |
full |
| Kampagne senden oder planen | POST |
/campaigns/{id}/send |
full |
| Kampagne stornieren | POST |
/campaigns/{id}/cancel |
full |
| Kampagnenstatistiken abrufen | GET |
/campaigns/{id}/stats |
full |
| Kampagne löschen | DELETE |
/campaigns/{id} |
full |
Produkte
Den Katalog Ihres Shops in Emailit pflegen, für Produktraster, Empfehlungen und Bestellpositionen. Die vollständige Referenz finden Sie unter Produkte. In den Tarifen Pro, Business und Contract in der Beta. Siehe Wer Commerce nutzen kann.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Produkt erstellen oder aktualisieren | POST |
/products |
events |
| Produkt abrufen | GET |
/products/{id} |
full |
| Produkt aktualisieren | POST |
/products/{id} |
events |
| Produkte auflisten | GET |
/products |
full |
| Produkte gesammelt erstellen oder aktualisieren | POST |
/products/batch |
events |
| Produktkategorien auflisten | GET |
/products/categories |
full |
| Produkt löschen | DELETE |
/products/{id} |
full |
Bestellungen
Die Bestellungen Ihres Shops senden, um Umsatz E-Mails zuzuordnen und Kaufprofile aufzubauen. Die vollständige Referenz finden Sie unter Bestellungen. In den Tarifen Pro, Business und Contract in der Beta. Siehe Wer Commerce nutzen kann.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Bestellung erstellen oder aktualisieren | POST |
/orders |
events |
| Bestellung abrufen | GET |
/orders/{id} |
full |
| Bestellung aktualisieren | POST |
/orders/{id} |
events |
| Bestellungen auflisten | GET |
/orders |
full |
| Bestellungen gesammelt importieren | POST |
/orders/batch |
events |
| Bestellung löschen | DELETE |
/orders/{id} |
full |
Warenkörbe
Die Warenkörbe Ihrer Käufer senden, damit Emailit abgebrochene Warenkörbe erkennt. Die vollständige Referenz finden Sie unter Warenkörbe. In den Tarifen Pro, Business und Contract in der Beta. Siehe Wer Commerce nutzen kann.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Warenkorb erstellen oder aktualisieren | POST |
/carts |
events |
| Warenkorb abrufen | GET |
/carts/{id} |
full |
| Warenkörbe auflisten | GET |
/carts |
full |
| Warenkorb löschen | DELETE |
/carts/{id} |
full |
Gutscheine
Gutscheine erstellen und ihre Pools mit eindeutigen Codes für E-Mails verwalten. Die vollständige Referenz finden Sie unter Gutscheine. In den Tarifen Pro, Business und Contract in der Beta. Siehe Wer Commerce nutzen kann.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Gutschein erstellen | POST |
/coupons |
full |
| Gutschein abrufen | GET |
/coupons/{id} |
full |
| Gutschein aktualisieren | POST |
/coupons/{id} |
full |
| Gutscheine auflisten | GET |
/coupons |
full |
| Gutschein löschen | DELETE |
/coupons/{id} |
full |
| Gutscheincodes auflisten | GET |
/coupons/{id}/codes |
full |
| Gutscheincodes hinzufügen | POST |
/coupons/{id}/codes |
full |
Commerce
Commerce-Einstellungen, die Umsatzübersicht und das Kaufprofil eines Kontakts. Die vollständige Referenz finden Sie unter Commerce. In den Tarifen Pro, Business und Contract in der Beta. Siehe Wer Commerce nutzen kann.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Commerce-Einstellungen abrufen | GET |
/commerce/settings |
full |
| Commerce-Einstellungen aktualisieren | POST |
/commerce/settings |
full |
| Commerce-Übersicht abrufen | GET |
/commerce/overview |
full |
| Kaufprofil eines Kontakts abrufen | GET |
/contacts/{id}/commerce |
full |
Automatisierungen
Workflows aus Triggern und Schritten aufbauen, ausführen und ihre Durchläufe einsehen. Die vollständige Referenz finden Sie unter Automatisierungen.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Automatisierung erstellen | POST |
/automations |
full |
| Automatisierung abrufen | GET |
/automations/{id} |
full |
| Automatisierung aktualisieren | POST |
/automations/{id} |
full |
| Automatisierungen auflisten | GET |
/automations |
full |
| Automatisierung löschen | DELETE |
/automations/{id} |
full |
| Automatisierung starten | POST |
/automations/{id}/start |
full |
| Automatisierung pausieren | POST |
/automations/{id}/pause |
full |
| Automatisierung stoppen | POST |
/automations/{id}/stop |
full |
| Durchlauf auslösen | POST |
/automations/{id}/trigger |
full |
| Durchläufe auflisten | GET |
/automations/{id}/runs |
full |
| Durchlauf abrufen | GET |
/automations/{id}/runs/{run_id} |
full |
| Statistiken abrufen | GET |
/automations/{id}/stats |
full |
| Schrittstatistiken abrufen | GET |
/automations/{id}/steps/{step_key}/stats |
full |
Formulare
Anmeldeformulare erstellen, veröffentlichen und ihr öffentliches Token rotieren. Die vollständige Referenz finden Sie unter Formulare.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Formular erstellen | POST |
/forms |
full |
| Formular abrufen | GET |
/forms/{id} |
full |
| Formular aktualisieren | POST |
/forms/{id} |
full |
| Formulare auflisten | GET |
/forms |
full |
| Formular veröffentlichen | POST |
/forms/{id}/publish |
full |
| Veröffentlichung eines Formulars zurückziehen | POST |
/forms/{id}/unpublish |
full |
| Öffentliches Token zurücksetzen | POST |
/forms/{id}/reset-token |
full |
| Formular löschen | DELETE |
/forms/{id} |
full |
Vorlagen
Vorlagenversionen erstellen, pro Alias eine davon veröffentlichen und sie beim Senden verwenden. Die vollständige Referenz finden Sie unter Vorlagen.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Vorlage erstellen | POST |
/templates |
full |
| Vorlage abrufen | GET |
/templates/{id} |
full |
| Vorlage aktualisieren | POST |
/templates/{id} |
full |
| Vorlagen auflisten | GET |
/templates |
full |
| Vorlage veröffentlichen | POST |
/templates/{id}/publish |
full |
| Vorlage löschen | DELETE |
/templates/{id} |
full |
Sperrungen
Die Adressen abrufen und verwalten, an die Emailit nicht sendet. Die vollständige Referenz finden Sie unter Sperrungen.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Sperrung erstellen | POST |
/suppressions |
full |
| Sperrung abrufen | GET |
/suppressions/{id} |
full |
| Sperrung aktualisieren | POST |
/suppressions/{id} |
full |
| Sperrungen auflisten | GET |
/suppressions |
full |
| Sperrung löschen | DELETE |
/suppressions/{id} |
full |
Webhooks
Endpunkte registrieren, die signierte Event-Benachrichtigungen empfangen. Die vollständige Referenz finden Sie unter Webhooks.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Webhook erstellen | POST |
/webhooks |
full |
| Webhook abrufen | GET |
/webhooks/{id} |
full |
| Webhook aktualisieren | POST |
/webhooks/{id} |
full |
| Webhooks auflisten | GET |
/webhooks |
full |
| Webhook löschen | DELETE |
/webhooks/{id} |
full |
| Test-Event senden | POST |
/webhooks/{id}/test |
full |
| Signatur-Secret rotieren | POST |
/webhooks/{id}/reset-secret |
full |
| Fehlgeschlagene Anfragen wiederholen | POST |
/webhooks/{id}/retry-failed |
full |
| Einzelne Anfrage wiederholen | POST |
/webhooks/{id}/requests/{request_id}/retry |
full |
Events
Workspace-Events und eigene Events senden und den Event-Stream hinter den Webhooks lesen: Zustellungen, Bounces, Öffnungen und mehr. Die vollständige Referenz finden Sie unter Events.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Event senden | POST |
/events |
events |
| Events gesammelt senden | POST |
/events/batch |
events |
| Events auflisten | GET |
/events |
full |
| Event abrufen | GET |
/events/{id} |
full |
Workspace-Events
Workspace-Events und die Typen ihrer Eigenschaften definieren. Die vollständige Referenz finden Sie unter Workspace-Events.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Workspace-Event erstellen | POST |
/workspace/events |
full |
| Workspace-Event abrufen | GET |
/workspace/events/{id} |
full |
| Workspace-Event aktualisieren | POST |
/workspace/events/{id} |
full |
| Workspace-Events auflisten | GET |
/workspace/events |
full |
| Workspace-Event löschen | DELETE |
/workspace/events/{id} |
full |
Tracking-Schlüssel
Die öffentlichen Schlüssel des Tracking-Skripts verwalten. Die vollständige Referenz finden Sie unter Tracking-Schlüssel.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Tracking-Schlüssel erstellen | POST |
/tracking-keys |
full |
| Tracking-Schlüssel abrufen | GET |
/tracking-keys/{id} |
full |
| Tracking-Schlüssel aktualisieren | POST |
/tracking-keys/{id} |
full |
| Tracking-Schlüssel auflisten | GET |
/tracking-keys |
full |
| Tracking-Schlüssel löschen | DELETE |
/tracking-keys/{id} |
full |
E-Mail-Verifizierung
Eine einzelne Adresse in Echtzeit verifizieren. Die vollständige Referenz finden Sie unter E-Mail-Verifizierung.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Adresse verifizieren | POST |
/email-verifications |
full |
Verifizierungslisten
Bis zu 10.000 Adressen auf einmal verifizieren und die Ergebnisse exportieren. Die vollständige Referenz finden Sie unter Verifizierungslisten.
| Endpunkt | Methode | Pfad | Scope |
|---|---|---|---|
| Liste erstellen | POST |
/email-verification-lists |
full |
| Listen auflisten | GET |
/email-verification-lists |
full |
| Liste abrufen | GET |
/email-verification-lists/{id} |
full |
| Ergebnisse auflisten | GET |
/email-verification-lists/{id}/results |
full |
| Ergebnisse exportieren | GET |
/email-verification-lists/{id}/export |
full |