Reference
Všechny endpointy
Všechny endpointy API v2 Emailitu na jednom místě, seskupené podle zdrojů, s metodou HTTP, cestou, potřebným oprávněním API klíče a odkazem na referenci.
Tato stránka uvádí všechny endpointy API Emailitu, seskupené podle zdrojů. Cesty jsou relativní k základní URL https://api.emailit.com/v2 a {id} označuje ID objektu (nebo, pokud to endpoint umožňuje, jeho název či e-mailovou adresu).
Sloupec Oprávnění ukazuje, které API klíče mohou endpoint volat:
| Oprávnění | Funguje s |
|---|---|
sending |
Klíči s oprávněním sending, nebo full. |
full |
Jen klíči s oprávněním full. |
Pro přístupové tokeny OAuth platí stejná pravidla jako pro API klíče se stejným oprávněním.
E-maily
Odesílejte e-maily, dohledávejte zprávy a jejich obsah a e-maily plánujte, rušte, odesílejte znovu nebo přeposílejte. Úplnou referenci najdete na stránce E-maily.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Odeslání e-mailu | POST |
/emails |
sending |
| Výpis e-mailů | GET |
/emails |
full |
| Načtení e-mailu | GET |
/emails/{id} |
full |
| Načtení surového MIME | GET |
/emails/{id}/raw |
full |
| Výpis příloh | GET |
/emails/{id}/attachments |
full |
| Načtení těla e-mailu | GET |
/emails/{id}/body |
full |
| Načtení metadat | GET |
/emails/{id}/meta |
full |
| Úprava naplánovaného e-mailu | POST |
/emails/{id} |
sending |
| Zrušení e-mailu | POST |
/emails/{id}/cancel |
sending |
| Opakované odeslání e-mailu | POST |
/emails/{id}/retry |
sending |
| Přeposlání e-mailu | POST |
/emails/{id}/forward |
sending |
| Načtení jen stavu | GET |
/email/{id} |
full |
Domény
Přidávejte odesílací domény, čtěte jejich DNS záznamy a stav ověření a ověřujte je. Úplnou referenci najdete na stránce Domény.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření domény | POST |
/domains |
full |
| Načtení domény | GET |
/domains/{id} |
full |
| Ověření domény | POST |
/domains/{id}/verify |
full |
| Úprava domény | POST |
/domains/{id} |
full |
| Výpis domén | GET |
/domains |
full |
| Smazání domény | DELETE |
/domains/{id} |
full |
DMARC reporty
Čtěte souhrnné a forenzní DMARC reporty odesílací domény, nebo nahrajte vlastní. Úplnou referenci najdete na stránce DMARC reporty.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Výpis souhrnných reportů | GET |
/domains/{id}/dmarc/reports |
full |
| Načtení reportu | GET |
/domains/{id}/dmarc/reports/{report_id} |
full |
| Nahrání reportu | POST |
/domains/{id}/dmarc/reports |
full |
| Výpis forenzních reportů | GET |
/domains/{id}/dmarc/forensic |
full |
| Načtení forenzního reportu | GET |
/domains/{id}/dmarc/forensic/{report_id} |
full |
| Načtení statistik | GET |
/domains/{id}/dmarc/stats |
full |
| Výpis odesílacích zdrojů | GET |
/domains/{id}/dmarc/sources |
full |
| Výpis zemí | GET |
/domains/{id}/dmarc/countries |
full |
| Výpis sítí (ASN) | GET |
/domains/{id}/dmarc/asns |
full |
| Výpis odesílatelů reportů | GET |
/domains/{id}/dmarc/reporters |
full |
API klíče
Vytvářejte, vypisujte, přejmenovávejte a odvolávejte API klíče workspace. Úplnou referenci najdete na stránce API klíče.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření API klíče | POST |
/api-keys |
full |
| Načtení API klíče | GET |
/api-keys/{id} |
full |
| Výpis API klíčů | GET |
/api-keys |
full |
| Úprava API klíče | POST |
/api-keys/{id} |
full |
| Nové vygenerování API klíče | POST |
/api-keys/{id}/regenerate |
full |
| Smazání API klíče | DELETE |
/api-keys/{id} |
full |
Seznamy kontaktů
Spravujte seznamy odběratelů pro kampaně a přihlašovací formuláře. Úplnou referenci najdete na stránce Seznamy kontaktů.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření seznamu kontaktů | POST |
/audiences |
full |
| Načtení seznamu kontaktů | GET |
/audiences/{id} |
full |
| Úprava seznamu kontaktů | POST |
/audiences/{id} |
full |
| Výpis seznamů kontaktů | GET |
/audiences |
full |
| Smazání seznamu kontaktů | DELETE |
/audiences/{id} |
full |
Odběratelé
Přidávejte, upravujte a odebírejte odběratele seznamu kontaktů. Úplnou referenci najdete na stránce Odběratelé.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Přidání odběratele | POST |
/audiences/{audience_id}/subscribers |
full |
| Načtení odběratele | GET |
/audiences/{audience_id}/subscribers/{id} |
full |
| Úprava odběratele | POST |
/audiences/{audience_id}/subscribers/{id} |
full |
| Výpis odběratelů | GET |
/audiences/{audience_id}/subscribers |
full |
| Smazání odběratele | DELETE |
/audiences/{audience_id}/subscribers/{id} |
full |
Kontakty
Spravujte profily kontaktů a vlastní pole, hromadně, nebo jednotlivě. Úplnou referenci najdete na stránce Kontakty.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření kontaktu | POST |
/contacts |
full |
| Načtení kontaktu | GET |
/contacts/{id} |
full |
| Úprava kontaktu | POST |
/contacts/{id} |
full |
| Výpis kontaktů | GET |
/contacts |
full |
| Hromadná úprava kontaktů | POST |
/contacts/bulk |
full |
| Export kontaktů | GET, POST |
/contacts/export |
full |
| Smazání kontaktu | DELETE |
/contacts/{id} |
full |
Kampaně
Vytvářejte kampaně, vybírejte pro ně seznamy kontaktů a kampaně odešlete hned, nebo je naplánujte. Úplnou referenci najdete na stránce Kampaně.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření kampaně | POST |
/campaigns |
full |
| Načtení kampaně | GET |
/campaigns/{id} |
full |
| Úprava kampaně | POST |
/campaigns/{id} |
full |
| Výpis kampaní | GET |
/campaigns |
full |
| Odeslání nebo naplánování kampaně | POST |
/campaigns/{id}/send |
full |
| Zrušení kampaně | POST |
/campaigns/{id}/cancel |
full |
| Smazání kampaně | DELETE |
/campaigns/{id} |
full |
Automatizace
Sestavujte workflow ze spouštěčů a kroků, spouštějte je a procházejte jejich spuštění. Úplnou referenci najdete na stránce Automatizace.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření automatizace | POST |
/automations |
full |
| Načtení automatizace | GET |
/automations/{id} |
full |
| Úprava automatizace | POST |
/automations/{id} |
full |
| Výpis automatizací | GET |
/automations |
full |
| Smazání automatizace | DELETE |
/automations/{id} |
full |
| Zapnutí automatizace | POST |
/automations/{id}/start |
full |
| Pozastavení automatizace | POST |
/automations/{id}/pause |
full |
| Zastavení automatizace | POST |
/automations/{id}/stop |
full |
| Ruční spuštění | POST |
/automations/{id}/trigger |
full |
| Výpis spuštění | GET |
/automations/{id}/runs |
full |
| Načtení spuštění | GET |
/automations/{id}/runs/{run_id} |
full |
| Načtení statistik | GET |
/automations/{id}/stats |
full |
| Načtení statistik kroků | GET |
/automations/{id}/steps/{step_key}/stats |
full |
Formuláře
Vytvářejte přihlašovací formuláře, publikujte je a vyměňujte jejich veřejný token. Úplnou referenci najdete na stránce Formuláře.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření formuláře | POST |
/forms |
full |
| Načtení formuláře | GET |
/forms/{id} |
full |
| Úprava formuláře | POST |
/forms/{id} |
full |
| Výpis formulářů | GET |
/forms |
full |
| Publikování formuláře | POST |
/forms/{id}/publish |
full |
| Stažení formuláře | POST |
/forms/{id}/unpublish |
full |
| Obnovení veřejného tokenu | POST |
/forms/{id}/reset-token |
full |
| Smazání formuláře | DELETE |
/forms/{id} |
full |
Šablony
Vytvářejte verze šablon, pro každý alias jednu publikujte a používejte je při odesílání. Úplnou referenci najdete na stránce Šablony.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření šablony | POST |
/templates |
full |
| Načtení šablony | GET |
/templates/{id} |
full |
| Úprava šablony | POST |
/templates/{id} |
full |
| Výpis šablon | GET |
/templates |
full |
| Publikování šablony | POST |
/templates/{id}/publish |
full |
| Smazání šablony | DELETE |
/templates/{id} |
full |
Blokované adresy
Čtěte a spravujte adresy, na které Emailit nebude odesílat. Úplnou referenci najdete na stránce Blokované adresy.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření blokace | POST |
/suppressions |
full |
| Načtení blokace | GET |
/suppressions/{id} |
full |
| Úprava blokace | POST |
/suppressions/{id} |
full |
| Výpis blokovaných adres | GET |
/suppressions |
full |
| Smazání blokace | DELETE |
/suppressions/{id} |
full |
Webhooky
Registrujte endpointy, které přijímají podepsaná oznámení o událostech. Úplnou referenci najdete na stránce Webhooky.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření webhooku | POST |
/webhooks |
full |
| Načtení webhooku | GET |
/webhooks/{id} |
full |
| Úprava webhooku | POST |
/webhooks/{id} |
full |
| Výpis webhooků | GET |
/webhooks |
full |
| Smazání webhooku | DELETE |
/webhooks/{id} |
full |
| Odeslání testovací události | POST |
/webhooks/{id}/test |
full |
| Výměna tajného klíče | POST |
/webhooks/{id}/reset-secret |
full |
| Opakování neúspěšných požadavků | POST |
/webhooks/{id}/retry-failed |
full |
| Opakování jednoho požadavku | POST |
/webhooks/{id}/requests/{request_id}/retry |
full |
Události
Čtěte proud událostí, ze kterého vycházejí webhooky: doručení, nedoručení, otevření a další. Úplnou referenci najdete na stránce Události.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Výpis událostí | GET |
/events |
full |
| Načtení události | GET |
/events/{id} |
full |
Ověřování e-mailů
Ověřte jednu adresu v reálném čase. Úplnou referenci najdete na stránce Ověřování e-mailů.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Ověření adresy | POST |
/email-verifications |
full |
Seznamy k ověření
Ověřte až 10 000 adres najednou a vyexportujte výsledky. Úplnou referenci najdete na stránce Seznamy k ověření.
| Endpoint | Metoda | Cesta | Oprávnění |
|---|---|---|---|
| Vytvoření seznamu k ověření | POST |
/email-verification-lists |
full |
| Výpis seznamů k ověření | GET |
/email-verification-lists |
full |
| Načtení seznamu k ověření | GET |
/email-verification-lists/{id} |
full |
| Výpis výsledků | GET |
/email-verification-lists/{id}/results |
full |
| Export výsledků | GET |
/email-verification-lists/{id}/export |
full |