Přejít na obsah
Dokumentace

Sestavujte workflow ze spouštěčů a kroků, spouštějte je a procházejte jejich spuštění.

Základní URLhttps://api.emailit.com/v2AutentizaceChybyLimity rychlosti

Vytvoření automatizace

Vytvoří automatizaci ve stavu draft z grafu kroků a propojení. Vyžaduje API klíč s oprávněním full. Automatizace jsou v betaverzi.

Dokud automatizaci nezapnete, nic nedělá. Každé spuštění stojí při startu 3 kredity a každý e-mail odeslaný akcí send_email nebo forward_email stojí 1 kredit navíc. V neověřeném workspace mohou tyto akce odesílat jen na e-mailové adresy účtů členů workspace.

POST/automations

Parametry v těle požadavku

contextstringpovinné
Čeho se každé spuštění týká: contact, email nebo event. Kontext určuje, které spouštěče a akce můžete použít, a později ho nelze změnit. Viz Kontexty.
namestringpovinné
Název automatizace, nejvýše 191 znaků.
descriptionstring | null
Volitelný popis.
settingsobject
Pravidla spouštění. Viz Nastavení.
stepsobject[]povinné
Kroky se spouštěči a akcemi, alespoň jeden spouštěč. Viz Kroky.
connectionsobject[]povinné
Hrany mezi kroky. Pro graf, který má jen spouštěč, předejte []. Viz Propojení.

Nastavení

exit_conditionsobject[]

Zruší spuštění kontaktu, jakmile se splní některá z těchto podmínek (kontext contact, nejvýše 20). Každá položka je buď definice události, tedy název spouštěče v event a jeho konfigurační pole, například { "event": "contact.tag_added", "tag": "customer" } nebo { "event": "contact.on_event", "event_name": "purchase" }, nebo podmínka nad kontaktem { "condition": { "match": "all", "rules": [...] } } s pravidly akce condition. Definice událostí přijímají všechny spouštěče kontaktu kromě datových spouštěčů a contact.visits_url a volitelný filter jako konfigurace spouštěčů. Události segmentů (s povinným segment_id) a události e-commerce jsou v alfaverzi, stejně jako jejich spouštěče. Definice contact.on_event, tady i v krocích goal a wait_until, vyžadují tarif Pro, Business nebo Custom. Viz Podmínky ukončení a cíle.

exit_on_audience_removalbooleanvýchozí: false
true zruší spuštění zahájené spouštěčem contact.added_to_audience, když je kontakt z daného seznamu kontaktů odebrán, když se z něj odhlásí nebo když se odhlásí ze všech marketingových e-mailů.
on_step_failurestringvýchozí: stop
stop při selhání kroku převede spuštění do stavu failed. skip neúspěšný krok zaznamená a pokračuje po jeho hranách default (nebo no po neúspěšné akci condition).
allow_reentrybooleanvýchozí: true
false přeskočí aktivaci spouštěče, pokud má stejný kontakt (nebo e-mail) v této automatizaci už probíhající spuštění.
max_concurrent_runsintegervýchozí: 0
Nejvyšší počet spuštění, která mohou být současně ve stavu running. 0 znamená bez limitu.
cooldown_secondsintegervýchozí: 0
Počet sekund, po které se další aktivace spouštěče přeskočí, když stejný kontakt (nebo e-mail) zahájil spuštění v této automatizaci.

Kroky

keystringpovinné
Váš identifikátor kroku, v rámci automatizace jedinečný, například welcome_email. Propojení, statistiky kroků a úpravy odkazují na kroky klíčem.
typestringpovinné
trigger, nebo action.
triggerstring
Název spouštěče, povinný, pokud má type hodnotu trigger. Viz Spouštěče.
actionstring
Název akce, povinný, pokud má type hodnotu action. Viz Akce.
configobject
Nastavení spouštěče nebo akce.

Propojení

fromstringpovinné
Klíč kroku, ve kterém hrana začíná.
tostringpovinné
Klíč následujícího kroku.
branchstringvýchozí: default
Který výsledek kroku from pokračuje po této hraně. Kroky condition používají yes a no, kroky wait_until matched a timeout (události a podmínky), nebo default a passed (data), kroky experiment klíče variant. Všechny ostatní kroky používají default.

Kontexty

Kontext Čeho se spuštění týká Spouštěče Pravidla
contact Jednoho kontaktu. send_email odesílá tomuto kontaktu. contact.*, system.* Jeden nebo více spouštěčů. Všechny musí vést do stejné první akce.
email Jednoho e-mailu (odeslaného, nebo přijatého). email.*, system.* Jeden nebo více spouštěčů. Všechny musí vést do stejné první akce.
event Jen obsahu spouštěče. event.*, system.* Právě jeden spouštěč.

Každá akce musí být dosažitelná ze spouštěče. Spuštění začne v akci propojené se spouštěčem, který se aktivoval, a pokračuje po propojeních:

  • condition pokračuje jen po hraně, jejíž branch je podle výsledku yes, nebo no.
  • wait_until pokračuje jen po matched, nebo timeout (události a podmínky), případně po default, nebo passed (data).
  • experiment pokračuje po hranách vybrané varianty. Když tato cesta skončí, spuštění pokračuje po hranách default kroku experimentu.
  • wait odloží další krok.
  • Všechny ostatní akce pokračují po svých hranách default. Krok s několika odchozími hranami pokračuje po všech.
  • Ke kroku goal se lze dostat i mimo pořadí: když kontakt cíl splní, spuštění na něj přeskočí a pokračuje za ním.

Spuštění přejde do stavu completed, když nezbývají žádné kroky nebo se provede krok end_run, do stavu failed, když krok selže (při on_step_failure: "stop"), a do stavu canceled, když se splní podmínka ukončení, spuštění se zruší nebo automatizaci zastavíte.

Spouštěče

Spouštěč Kontext Kdy se aktivuje
contact.added_to_audience contact Kontakt se přihlásí k odběru seznamu kontaktů, včetně opětovného přihlášení.
contact.removed_from_audience contact Odběratel se ze seznamu kontaktů smaže.
contact.added_to_segment contact Kontakt vstoupí do sledovaného segmentu. Neplatí pro změny způsobené úpravou segmentu. Alfaverze: spouštěče segmentů může přidávat jen tým Emailitu; ostatní požadavky vracejí 403 s error: "segments_alpha".
contact.removed_from_segment contact Kontakt opustí sledovaný segment. Neplatí pro změny způsobené úpravou segmentu. Alfaverze, stejně jako contact.added_to_segment.
contact.created contact Vytvoří se kontakt.
contact.updated contact Kontakt se upraví, včetně štítků a skóre.
contact.tag_added, contact.tag_removed contact Kontaktu se přidá nebo odebere štítek.
contact.score_changed contact Změní se skóre kontaktu.
contact.unsubscribed contact Kontakt se odhlásí ze seznamu kontaktů, nebo ze všech marketingových e-mailů.
contact.loaded_email contact Příjemce, který je kontaktem ve workspace, otevře e-mail.
contact.clicked_in_email contact Příjemce, který je kontaktem ve workspace, klikne na měřený odkaz.
contact.on_date contact Nastane datum z datového vlastního pole, volitelně posunuté o dny nebo týdny, v určitý čas dne v daném časovém pásmu. Jednou, nebo s repeat: "yearly" každý rok.
contact.date_anniversary contact Každý rok v měsíc a den z datového vlastního pole, se stejnými možnostmi.
contact.on_event contact Vlastní událost (c:) nebo událost workspace (w:) pro kontakt. Tarify Business a Custom: ostatní tarify dostanou 403 s error: "plan_required" a required_plan: "business".
form.submitted contact Odešle se formulář s e-mailovou adresou.
contact.on_purchase contact Kontakt zadá novou objednávku. Alfaverze: spouštěče e-commerce může přidávat jen tým Emailitu; ostatní požadavky vracejí 403 s error: "commerce_alpha".
contact.abandoned_cart contact Košík kontaktu se stane opuštěným. Alfaverze, stejně jako contact.on_purchase.
contact.visits_url contact Přijímá se, ale Emailit ho zatím neaktivuje.
email.received email Dorazí příchozí e-mail.
email.delivered, email.bounced, email.complained, email.loaded, email.clicked, email.failed, email.suppressed, email.canceled email Nastane stejnojmenná událost e-mailu.
event.<name> event Jakýkoli název, který začíná na event.. Emailit zatím události event.* nevyvolává; automatizace s kontextem event spouštějte přes system.manual.
system.manual všechny Zavoláte Ruční spuštění.
system.schedule všechny Přijímá se, ale Emailit plánované spouštěče zatím neaktivuje.

Pole config spouštěče:

audience_idstring
Pro contact.added_to_audience a contact.removed_from_audience: spouštěč se aktivuje jen pro tento seznam kontaktů (aud_…).
segment_idstring
Pro contact.added_to_segment a contact.removed_from_segment: sledovaný segment (seg_…). Při vytvoření automatizace je volitelný, při úpravě jejích kroků povinný. Segment, který neexistuje nebo není sledovaný, vrací 400.
include_current_membersbooleanvýchozí: false
Pro contact.added_to_segment: při prvním zapnutí automatizace zahájí spuštění také pro každý kontakt, který už v segmentu je. Nastavení opakovaného vstupu stále platí.
date_fieldstring
Pro contact.date_anniversary a contact.on_date: klíč vlastního pole, které obsahuje datum, například birthday.
offset, time, timezone, repeatobject, string, string, string
Pro datové spouštěče: offset je { "amount": 3, "unit": "days", "direction": "before" } (unit je days, nebo weeks), time je HH:MM (výchozí 00:00), timezone název IANA (výchozí UTC) a repeat u contact.on_date hodnota once, nebo yearly.
tagstring
Pro contact.tag_added a contact.tag_removed: jen tento štítek.
threshold, directionnumber, string
Pro contact.score_changed: jen když skóre překročí threshold, směrem up (výchozí), nebo down.
fieldstring
Pro contact.updated: jen když se změnilo toto pole, například custom_fields.purchased, tags nebo score.
event_namestring
Pro contact.on_event: název události, například purchase (odpovídá c:purchase i w:purchase) nebo w:webinar.attended. Když ho vynecháte, spouštěč se aktivuje pro jakoukoli událost workspace nebo vlastní událost. Podle vlastností události filtrujte přes filter, například properties.total.
form_idstring
Pro form.submitted: jen tento formulář.
filterobject

Spouštěč se aktivuje, jen když událost odpovídá: { "match": "all", "rules": [{ "field": "subject", "operator": "contains", "value": "Invoice" }] }. match je all (výchozí), nebo any. field je cesta s tečkami do pole object události, například to nebo email.subject; úvodní payload. se ignoruje.

Operátory: equals, not_equals, contains, not_contains, starts_with, ends_with, greater_than, less_than, in, not_in, is_set, is_not_set. Všechny operátory kromě is_set a is_not_set potřebují value; in a not_in přijímají pole.

Akce

Akce Kontext Konfigurace
send_email všechny type (povinné, template), template_id (povinné: ID tem_ nebo alias publikované šablony), from, subject, reply_to, to, email_type, tracking
forward_email email, event to (povinné), from, subject, email_id
wait všechny seconds (povinné, od 0 do 2 592 000, tedy 30 dní)
wait_until všechny (režimy event a condition: contact) mode (date, event nebo condition) a pole daného režimu
condition všechny filter (povinné, viz Podmínky)
goal contact event, nebo condition, if_not_met
experiment všechny variants (povinné), control
call_webhook všechny url (povinné), method, headers, body, secret, fail_on_error
run_automation všechny automation_id (povinné), exit_current
exit_automation contact automation_ids, nebo all: true
end_run všechny Žádná
end všechny Žádná
add_tag, remove_tag contact tags (povinné)
update_score contact operation (add, subtract nebo set), value (povinné)
add_to_audience contact audience_id (povinné), emit_events
remove_from_audience contact audience_id (povinné), mode (remove, nebo unsubscribe), emit_events
update_subscription contact action (subscribe, nebo unsubscribe, povinné), scope (audience, all_audiences nebo global), audience_id
edit_contact contact fields (povinné), emit_events
add_to_suppressions email, event type, reason, email
remove_from_suppressions email, event email
create_contact email, event email, first_name, audience_id, emit_events
  • send_email odešle šablonu. Ve výchozím stavu se jako from použije odesílatel šablony; adresa musí být na ověřené odesílací doméně. subject přepíše předmět šablony. reply_to je adresa, nebo pole adres a může obsahovat proměnnou. V kontextu contact jde e-mail kontaktu daného spuštění; v kontextech email a event nastavte to. email_type je marketing (výchozí v kontextu contact: přeskočí odhlášené kontakty a přidá odkaz pro odhlášení a hlavičky List-Unsubscribe), nebo transactional. tracking: { "loads": true, "clicks": true } přepíše nastavení měření domény a tracking: {} se k němu vrátí.
  • wait_until čeká na datum: { "mode": "date", "date": { "type": "global", "key": "webinar_date" }, "offset": { "amount": 1, "unit": "days", "direction": "before" }, "time": "09:00", "timezone": "Europe/Prague", "if_passed": "continue" }, kde date.type je contact (s field), global (s key), fixed (s value) nebo payload (s path) a if_passed je continue, nebo branch. Na událost: { "mode": "event", "event": { "event": "contact.clicked_in_email" }, "timeout": { "amount": 2, "unit": "days" } }. Na podmínku: { "mode": "condition", "condition": { ... }, "timeout": ... }. Čekání trvá nejvýše 365 dní. Viz Wait until.
  • goal přijímá definici události v event (stejně jako exit_conditions), nebo condition. Když kontakt cíl splní, spuštění na něj přeskočí. if_not_met (continue, wait nebo end) určuje, co se stane, když spuštění dojde k cíli dřív, než ho kontakt splní. Cíle vyžadují tarif Pro, Business nebo Custom.
  • forward_email přepošle e-mail daného spuštění (nebo e-mail z email_id) na adresu v to. Výchozí hodnota from je původní odesílatel a výchozí hodnota subject je Fwd: <original subject>.
  • condition přijímá { "match": "all" | "any", "rules": [...] }. Viz Podmínky. Krok pokračuje větví yes, nebo no.
  • experiment náhodně podle váhy vybere jednu z variants (a control), každou ve tvaru { "key": "a", "weight": 50 }, a pokračuje větví pojmenovanou podle vybraného klíče.
  • call_webhook pošle HTTP požadavek (výchozí metoda POST, Content-Type JSON) a zaznamená třídu stavového kódu (2xx, 4xx, 5xx), případně timeout nebo network_error. Bez body pošle automatizaci, spuštění, kontakt a obsah jako JSON. Se secret se tělo podepíše v hlavičce X-Emailit-Signature. Odpověď s jiným kódem než 2xx neznamená selhání kroku, pokud fail_on_error nemá hodnotu true. Soukromé adresy jsou blokované.
  • run_automation spustí jinou běžící automatizaci pro stejný kontakt s obsahem tohoto spuštění. Aktuální spuštění pokračuje, nebo s exit_current: true skončí.
  • exit_automation zruší probíhající spuštění kontaktu v automatizacích z automation_ids, nebo s all: true ve všech ostatních automatizacích.
  • end_run ukončí spuštění včetně ostatních větví. end ukončí jen vlastní větev.
  • add_tag a remove_tag mění štítky kontaktu. update_score mění skóre kontaktu.
  • update_subscription přihlásí nebo odhlásí kontakt z jednoho seznamu kontaktů, ze všech seznamů (jen unsubscribe), nebo ze všech marketingových e-mailů (global).
  • remove_from_audience smaže členství kontaktu v seznamu (mode: "remove", výchozí), nebo ho v seznamu ponechá jako odhlášený (mode: "unsubscribe").
  • emit_events (výchozí hodnota true) u add_to_audience, remove_from_audience, create_contact a edit_contact posílá obvyklé události subscriber.* a contact.*, takže je dostanou webhooky a spustí se jiné automatizace. Kroky uložené před 2026-10-20 mají emit_events: false a jejich kroky remove_from_audience mají mode: "unsubscribe".
  • edit_contact přijímá fields: [{ "key": "first_name", "value": "Ada" }]. Klíče email, first_name, last_name a unsubscribed upraví kontakt; jakýkoli jiný klíč (s předponou custom_fields., nebo bez ní) nastaví vlastní pole a hodnotu převede na jeho typ. operation je set (výchozí), clear, increment nebo decrement.
  • add_to_suppressions zablokuje adresu daného spuštění (výchozí type je recipient, výchozí reason je automation). remove_from_suppressions blokaci odebere. V kontextu event předejte email.
  • create_contact vytvoří kontakt (nebo najde existující) a volitelně ho přihlásí k odběru seznamu audience_id. V kontextu email je výchozí hodnotou email příjemce e-mailu.

Textové hodnoty v konfiguraci jakékoli akce mohou obsahovat proměnné, které Emailit doplní při provedení kroku: {{contact.email}}, {{cf.plan}}, {{global.webinar_link}}, {{email.mail_from}}, {{payload.object.subject}} nebo {{meta.source_event_id}}, například "to": "{{email.mail_from}}". Šablony odeslané akcí send_email i její subject se vykreslují jazykem Temple a mají přímo k dispozici i pole kontaktu, například {{ first_name }}, {{tags}} a {{score}}.

Podmínky

Filtr condition (a také podmínky v wait_until a goal a exit_conditions) má tvar { "match": "all" | "any", "rules": [...] }. Pravidlo je { "field", "operator", "value" }, nebo vnořená skupina { "match", "rules" }, nejvýše 3 úrovně a 50 pravidel.

field operator value
Pole kontaktu (email, first_name, last_name, created_at, unsubscribed, score), subscribed, custom_fields.<key>, global.<key>, payload.<path>, meta.<path>, contact.<path>, email.<path> equals, not_equals, contains, not_contains, starts_with, ends_with, in, not_in, is_set, is_not_set, greater_than, less_than, greater_or_equal, less_or_equal, is_true, is_false, before, after, on, is_past, is_future, within_last, within_next, more_than_ago, more_than_from_now Hodnota. Operátory se dny přijímají počet dní nebo { "amount", "unit" }. U is_set, is_not_set, is_true, is_false, is_past a is_future není potřeba.
tags contains, not_contains, in, not_in, is_set, is_not_set Štítek, nebo pole štítků pro in a not_in.
audience is_subscribed, is_not_subscribed, is_member, is_not_member ID seznamu kontaktů (aud_…).
engagement opened, not_opened, clicked, not_clicked "run", "automation", { "scope": "step", "step": "<key>" }, { "scope": "any", "days": 30 } nebo { "scope": "campaign", "campaign_id": "cmp_…" }.
segment is_member, is_not_member ID segmentu (seg_…), sledovaného i běžného. Alfaverze.
commerce.<field> Operátory daného pole ze segmentů, kromě pěti, které používají názvy z této tabulky: greater_or_equal, less_or_equal, within_last, within_next a more_than_ago Hodnota, kterou přijímá pravidlo segmentu. Alfaverze. Viz níže.

Pole bez předpony se vyhodnotí vůči kontaktu (first_name, custom_fields.plan), nebo e-mailu (rcpt_to, subject) daného spuštění. subscribed má hodnotu true, když kontakt může dostávat marketingové e-maily.

Pravidla commerce.<field> používají pole e-commerce ze segmentů a vyhodnocují se stejně: orders_count, total_spent, average_order_value, first_order_at, last_order_at, expected_next_order_at, last_active_at, churn_risk, purchased, viewed_product, used_coupon a cart, například { "field": "commerce.purchased", "operator": "has", "value": { "days": 30, "product_ids": ["sku-1"] } }. Pravidla segmentů a e-commerce jsou v alfaverzi: ostatní požadavky, které je přidávají, vracejí 403 s error segments_alpha, nebo commerce_alpha. Automatizace, které je už mají, dál fungují pro všechny.

Odpověď

Vrací 201 Created s automatizací v poli data, včetně ID každého kroku (aus_…) a propojení. status je draft.

Při vytvoření se kontroluje struktura grafu: názvy spouštěčů a akcí pro daný kontext, jedinečnost klíčů, platnost propojení a větví, dosažitelnost, settings a to, že každá adresa from v akci send_email používá ověřenou odesílací doménu. Nekontroluje se, zda je konfigurace každé akce úplná; to dělá Úprava automatizace. Chyby vracejí 400 s polem errors, jehož klíče jsou cesty k polím.

Funkce, které tarif workspace nezahrnuje, vracejí 403 s error: "plan_required", nejnižším tarifem, který je obsahuje, v required_plan a polem message. Kroky goal a definice contact.on_event v exit_conditions, goal a wait_until vyžadují pro a spouštěč contact.on_event vyžaduje business.

POST/automations
Terminal
curl -X POST https://api.emailit.com/v2/automations \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome series",
    "context": "contact",
    "description": "Welcome new subscribers, then nudge free users a day later.",
    "settings": { "allow_reentry": false },
    "steps": [
      {
        "key": "joined",
        "type": "trigger",
        "trigger": "contact.added_to_audience",
        "config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
      },
      {
        "key": "welcome_email",
        "type": "action",
        "action": "send_email",
        "config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
      },
      {
        "key": "wait_1_day",
        "type": "action",
        "action": "wait",
        "config": { "seconds": 86400 }
      },
      {
        "key": "is_free_user",
        "type": "action",
        "action": "condition",
        "config": {
          "filter": {
            "match": "all",
            "rules": [{ "field": "custom_fields.plan", "operator": "is_not_set" }]
          }
        }
      },
      {
        "key": "upgrade_tips",
        "type": "action",
        "action": "send_email",
        "config": { "type": "template", "template_id": "getting-started-tips" }
      },
      { "key": "done", "type": "action", "action": "end" }
    ],
    "connections": [
      { "from": "joined", "to": "welcome_email" },
      { "from": "welcome_email", "to": "wait_1_day" },
      { "from": "wait_1_day", "to": "is_free_user" },
      { "from": "is_free_user", "to": "upgrade_tips", "branch": "yes" },
      { "from": "is_free_user", "to": "done", "branch": "no" }
    ]
  }'
JSON
{
  "data": {
    "id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
    "context": "contact",
    "name": "Welcome series",
    "description": "Welcome new subscribers, then nudge free users a day later.",
    "status": "draft",
    "settings": { "allow_reentry": false },
    "last_triggered_at": null,
    "published_at": null,
    "created_at": "2026-10-01T09:41:05.318274+00:00",
    "updated_at": "2026-10-01T09:41:05.318274+00:00",
    "steps": [
      {
        "id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
        "key": "joined",
        "type": "trigger",
        "trigger": "contact.added_to_audience",
        "action": null,
        "config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
      },
      {
        "id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
        "key": "welcome_email",
        "type": "action",
        "trigger": null,
        "action": "send_email",
        "config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
      },
      {
        "id": "aus_3vM0ORwEXCQcyS7rylfQBQEXjVk",
        "key": "wait_1_day",
        "type": "action",
        "trigger": null,
        "action": "wait",
        "config": { "seconds": 86400 }
      },
      {
        "id": "aus_3HOgOzxaXBgVRpLFtpvJNo4vd5c",
        "key": "is_free_user",
        "type": "action",
        "trigger": null,
        "action": "condition",
        "config": {
          "filter": {
            "match": "all",
            "rules": [{ "field": "custom_fields.plan", "operator": "is_not_set" }]
          }
        }
      },
      {
        "id": "aus_3gCI5SWMPFVhOSawR6nz8sF55wp",
        "key": "upgrade_tips",
        "type": "action",
        "trigger": null,
        "action": "send_email",
        "config": { "type": "template", "template_id": "getting-started-tips" }
      },
      {
        "id": "aus_3Pq7Wd2LxN8cVt5RmK0sHy4BfJe",
        "key": "done",
        "type": "action",
        "trigger": null,
        "action": "end",
        "config": {}
      }
    ],
    "connections": [
      { "from": "joined", "to": "welcome_email", "branch": "default" },
      { "from": "welcome_email", "to": "wait_1_day", "branch": "default" },
      { "from": "wait_1_day", "to": "is_free_user", "branch": "default" },
      { "from": "is_free_user", "to": "upgrade_tips", "branch": "yes" },
      { "from": "is_free_user", "to": "done", "branch": "no" }
    ]
  },
  "message": "Automation was successfully created.",
  "notify": true
}

Načtení automatizace

Načte automatizaci s celým grafem. Vyžaduje API klíč s oprávněním full.

GET/automations/{id}

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Odpověď

Vrací automatizaci v poli data.

idstring
ID automatizace s předponou aut_.
contextstring
contact, email nebo event.
namestring
Název automatizace.
descriptionstring | null
Volitelný popis.
statusstring
draft, running, paused, stopped nebo archived.
settingsobject
Pravidla spouštění: on_step_failure, allow_reentry, max_concurrent_runs, cooldown_seconds. Prázdné, pokud jste žádné nenastavili.
last_triggered_atstring | null
Kdy automatizace naposledy zahájila spuštění.
published_atstring | null
Kdy byla automatizace poprvé zapnuta.
stepsobject[]
Pro každý krok jeho id (aus_…), key, type, trigger, action a config. Podrobnosti spuštění odkazují na kroky podle id, statistiky podle key.
connectionsobject[]
Pro každou hranu klíče kroků from a to a její branch.

Význam jednotlivých spouštěčů, akcí a nastavení najdete na stránce Vytvoření automatizace. Pokud automatizace neexistuje nebo byla smazána, vrací 404.

GET/automations/{id}
Terminal
curl https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "data": {
    "id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
    "context": "contact",
    "name": "Welcome series",
    "description": "Welcome new subscribers, then nudge free users a day later.",
    "status": "running",
    "settings": { "allow_reentry": false },
    "last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
    "published_at": "2026-10-01T10:00:02.204118+00:00",
    "created_at": "2026-10-01T09:41:05.318274+00:00",
    "updated_at": "2026-10-03T14:12:40.551870+00:00",
    "steps": [
      {
        "id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
        "key": "joined",
        "type": "trigger",
        "trigger": "contact.added_to_audience",
        "action": null,
        "config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
      },
      {
        "id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
        "key": "welcome_email",
        "type": "action",
        "trigger": null,
        "action": "send_email",
        "config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
      },
      {
        "id": "aus_3vM0ORwEXCQcyS7rylfQBQEXjVk",
        "key": "wait_1_day",
        "type": "action",
        "trigger": null,
        "action": "wait",
        "config": { "seconds": 86400 }
      }
    ],
    "connections": [
      { "from": "joined", "to": "welcome_email", "branch": "default" },
      { "from": "welcome_email", "to": "wait_1_day", "branch": "default" }
    ]
  }
}

Úprava automatizace

Upraví název, popis, nastavení nebo graf automatizace. Vyžaduje API klíč s oprávněním full. Kontext nelze změnit.

Pokud chcete změnit graf, pošlete steps a connections společně; nahradí aktuální graf. Kroky, jejichž key už existuje, si ponechají ID a historii spuštění, kroky, které vynecháte, se smažou, a nové klíče se přidají. Na rozdíl od vytvoření úprava validuje i konfiguraci každé akce (například send_email potřebuje type a template_id, wait potřebuje seconds). Když si krok ponechá svůj key i akci, nastavení, která v jeho config vynecháte, si ponechají uložené hodnoty: email_type a tracking u send_email, emit_events u kroků pro kontakty a mode u remove_from_audience. Pokud chcete nastavení změnit, pošlete ho; tracking: {} se vrátí k nastavení měření domény.

Než změníte graf běžící automatizace, automatizaci pozastavte a pak ji znovu zapněte, aby se nové spouštěče projevily.

POST/automations/{id}

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Parametry v těle požadavku

namestring
Název, nejvýše 191 znaků.
descriptionstring
Popis.
settingsobject
Nahradí všechna nastavení: exit_conditions, exit_on_audience_removal, on_step_failure, allow_reentry, max_concurrent_runs, cooldown_seconds. Viz Nastavení. Nové podmínky ukončení platí pro probíhající spuštění, a to i u běžících automatizací.
stepsobject[]
Úplný seznam kroků. Povinné, pokud posíláte connections. Viz Kroky.
connectionsobject[]
Úplný seznam propojení. Povinné, pokud posíláte steps. Viz Propojení.

Odpověď

Vrací upravenou automatizaci v poli data spolu s message a notify. Pokud validace selže, vrací 400 s polem errors, jehož klíče jsou cesty k polím, pokud úprava přidává krok, spouštěč nebo podmínku ukončení, které tarif nezahrnuje, 403 s error: "plan_required" (viz Vytvoření automatizace) a pokud automatizace neexistuje, 404. Co už automatizace má, zůstane povolené i po přechodu na nižší tarif.

POST/automations/{id}
Terminal
curl -X POST https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome series (v2)",
    "settings": { "allow_reentry": false, "on_step_failure": "skip" }
  }'
JSON
{
  "data": {
    "id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
    "context": "contact",
    "name": "Welcome series (v2)",
    "description": "Welcome new subscribers, then nudge free users a day later.",
    "status": "paused",
    "settings": { "allow_reentry": false, "on_step_failure": "skip" },
    "last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
    "published_at": "2026-10-01T10:00:02.204118+00:00",
    "created_at": "2026-10-01T09:41:05.318274+00:00",
    "updated_at": "2026-10-04T08:15:22.730115+00:00",
    "steps": [
      {
        "id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
        "key": "joined",
        "type": "trigger",
        "trigger": "contact.added_to_audience",
        "action": null,
        "config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
      },
      {
        "id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
        "key": "welcome_email",
        "type": "action",
        "trigger": null,
        "action": "send_email",
        "config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
      }
    ],
    "connections": [
      { "from": "joined", "to": "welcome_email", "branch": "default" }
    ]
  },
  "message": "Automation was successfully updated.",
  "notify": true
}

Výpis automatizací

Vrátí automatizace workspace od nejnovějších, bez jejich kroků a propojení. Vyžaduje API klíč s oprávněním full. Smazané automatizace se nevypisují.

GET/automations

Parametry dotazu

pageintegervýchozí: 1
Číslo stránky, od 1.
per_pageintegervýchozí: 25
Počet automatizací na stránce, od 1 do 100.
filter[context]string
Jen automatizace s tímto kontextem: contact, email nebo event.
filter[status]string
Jen automatizace v tomto stavu: draft, running, paused, stopped nebo archived.
filter[name]string
Hledá v části názvu bez ohledu na velikost písmen.
sortstringvýchozí: created_at
Pole pro řazení: name, created_at, updated_at nebo last_triggered_at.
orderstringvýchozí: desc
Směr řazení: asc, nebo desc.

Můžete také použít obecné filtry key.condition=value na name, status, context a created_at, spolu s match. Viz Filtrování.

Odpověď

dataobject[]
Automatizace na této stránce: id, context, name, description, status, settings, last_triggered_at, published_at, created_at, updated_at. settings je v tomto výpisu vždy prázdný objekt; pokud ho chcete přečíst, načtěte automatizaci.
total_recordsinteger
Počet odpovídajících automatizací.
per_pageinteger
Použitá velikost stránky.
current_pageinteger
Číslo této stránky.
total_pagesinteger
Počet stránek.
GET/automations
Terminal
curl -G https://api.emailit.com/v2/automations \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  --data-urlencode "filter[status]=running" \
  -d sort=last_triggered_at \
  -d per_page=50
JSON
{
  "data": [
    {
      "id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
      "context": "contact",
      "name": "Welcome series",
      "description": "Welcome new subscribers, then nudge free users a day later.",
      "status": "running",
      "settings": {},
      "last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
      "published_at": "2026-10-01T10:00:02.204118+00:00",
      "created_at": "2026-10-01T09:41:05.318274+00:00",
      "updated_at": "2026-10-03T14:12:40.551870+00:00"
    }
  ],
  "total_records": 1,
  "per_page": 50,
  "current_page": 1,
  "total_pages": 1
}

Smazání automatizace

Smaže automatizaci. Zmizí z výpisů a přestane reagovat na spouštěče. Vyžaduje API klíč s oprávněním full.

Spuštění, která už probíhají, se nezruší. Pokud je chcete zrušit, automatizaci zastavte dřív, než ji smažete.

DELETE/automations/{id}

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Odpověď

Vrací pole message, které smazání potvrzuje. Pokud automatizace neexistuje nebo už byla smazána, vrací 404.

DELETE/automations/{id}
Terminal
curl -X DELETE https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "message": "Automation was deleted successfully.",
  "notify": true
}

Zapnutí automatizace

Převede automatizaci do stavu running. Od té chvíle odpovídající spouštěče zahajují spuštění; události, které nastaly před zapnutím, ne. Vyžaduje API klíč s oprávněním full.

Zapnout můžete automatizaci ve stavu draft, paused nebo stopped. První zapnutí nastaví published_at. Jen při prvním zapnutí zahájí spouštěče contact.added_to_segment s include_current_members: true spuštění také pro každý kontakt, který už je v jejich sledovaném segmentu.

Při zapnutí se graf znovu nevaliduje. Pokud jste automatizaci sestavili přes Vytvoření automatizace, které kontroluje jen strukturu, ujistěte se, že je konfigurace každé akce úplná, nebo graf jednou pošlete přes Úpravu automatizace, která ho zvaliduje úplně. Krok s neúplnou konfigurací selže, jakmile na něj spuštění dojde.

POST/automations/{id}/start

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Odpověď

Vrací automatizaci v poli data s polem status nastaveným na running. Pokud automatizace neexistuje, vrací 404.

POST/automations/{id}/start
Terminal
curl -X POST https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/start \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "data": {
    "id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
    "context": "contact",
    "name": "Welcome series",
    "description": "Welcome new subscribers, then nudge free users a day later.",
    "status": "running",
    "settings": { "allow_reentry": false },
    "last_triggered_at": null,
    "published_at": "2026-10-01T10:00:02.204118+00:00",
    "created_at": "2026-10-01T09:41:05.318274+00:00",
    "updated_at": "2026-10-01T10:00:02.204118+00:00",
    "steps": [
      {
        "id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
        "key": "joined",
        "type": "trigger",
        "trigger": "contact.added_to_audience",
        "action": null,
        "config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
      },
      {
        "id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
        "key": "welcome_email",
        "type": "action",
        "trigger": null,
        "action": "send_email",
        "config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
      }
    ],
    "connections": [
      { "from": "joined", "to": "welcome_email", "branch": "default" }
    ]
  },
  "message": "Automation was successfully started.",
  "notify": true
}

Pozastavení automatizace

Převede automatizaci do stavu paused. Její spouštěče přestanou zahajovat nová spuštění, ale už probíhající spuštění pokračují, včetně těch, která čekají na kroku wait. Vyžaduje API klíč s oprávněním full.

Pokud chcete zrušit i probíhající spuštění, automatizaci místo toho zastavte. Spouštěče znovu aktivujete tím, že automatizaci opět zapnete.

POST/automations/{id}/pause

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Odpověď

Vrací automatizaci v poli data s polem status nastaveným na paused. Pokud automatizace neexistuje, vrací 404.

POST/automations/{id}/pause
Terminal
curl -X POST https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/pause \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "data": {
    "id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
    "context": "contact",
    "name": "Welcome series",
    "description": "Welcome new subscribers, then nudge free users a day later.",
    "status": "paused",
    "settings": { "allow_reentry": false },
    "last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
    "published_at": "2026-10-01T10:00:02.204118+00:00",
    "created_at": "2026-10-01T09:41:05.318274+00:00",
    "updated_at": "2026-10-04T08:10:51.004732+00:00",
    "steps": [
      {
        "id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
        "key": "joined",
        "type": "trigger",
        "trigger": "contact.added_to_audience",
        "action": null,
        "config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
      },
      {
        "id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
        "key": "welcome_email",
        "type": "action",
        "trigger": null,
        "action": "send_email",
        "config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
      }
    ],
    "connections": [
      { "from": "joined", "to": "welcome_email", "branch": "default" }
    ]
  },
  "message": "Automation was successfully paused.",
  "notify": true
}

Zastavení automatizace

Převede automatizaci do stavu stopped a zruší každé spuštění, které je ještě ve stavu running; tato spuštění dostanou stav canceled a jejich zbývající kroky se neprovedou. Vyžaduje API klíč s oprávněním full.

Zastavení je dostupné jen přes API. Pokud chcete, aby probíhající spuštění pokračovala, automatizaci místo toho pozastavte. Zastavenou automatizaci můžete znovu zapnout; nová spuštění začnou od začátku.

POST/automations/{id}/stop

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Odpověď

Vrací automatizaci v poli data s polem status nastaveným na stopped. Pokud automatizace neexistuje, vrací 404.

POST/automations/{id}/stop
Terminal
curl -X POST https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/stop \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "data": {
    "id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
    "context": "contact",
    "name": "Welcome series",
    "description": "Welcome new subscribers, then nudge free users a day later.",
    "status": "stopped",
    "settings": { "allow_reentry": false },
    "last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
    "published_at": "2026-10-01T10:00:02.204118+00:00",
    "created_at": "2026-10-01T09:41:05.318274+00:00",
    "updated_at": "2026-10-05T16:45:09.882301+00:00",
    "steps": [
      {
        "id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
        "key": "joined",
        "type": "trigger",
        "trigger": "contact.added_to_audience",
        "action": null,
        "config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
      },
      {
        "id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
        "key": "welcome_email",
        "type": "action",
        "trigger": null,
        "action": "send_email",
        "config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
      }
    ],
    "connections": [
      { "from": "joined", "to": "welcome_email", "branch": "default" }
    ]
  },
  "message": "Automation was successfully stopped.",
  "notify": true
}

Ruční spuštění

Aktivuje spouštěč system.manual s obsahem, který zvolíte. Automatizace musí být ve stavu running a mít krok se spouštěčem system.manual; jinak se žádné spuštění nezahájí. Vyžaduje API klíč s oprávněním full. Ruční spouštěče jsou dostupné jen přes API.

Spuštění se zahájí asynchronně a stojí 3 kredity jako každé jiné spuštění. Najdete ho přes Výpis spuštění.

POST/automations/{id}/trigger

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Parametry v těle požadavku

payloadobject

Data pro spuštění. Emailit přidá automation_id a výsledek uloží jako payload spuštění. Kroky ho mohou číst přes proměnné, například {{payload.order_id}}, a přes podmínky, například payload.plan.

Čeho se spuštění týká, závisí na kontextu automatizace:

  • contact: předejte contact_id (con_…). Akce s kontakty a send_email použijí tento kontakt.
  • email: předejte email_id (em_…). Akce s e-maily použijí tento e-mail.
  • event: libovolná data. V konfiguraci akcí nastavte to nebo email, například "to": "{{payload.customer_email}}".

Odpověď

Jakmile se aktivace spouštěče zařadí do fronty, vrací 200 s polem message. Pokud automatizace není ve stavu running, vrací 422, a pokud neexistuje, 404.

POST/automations/{id}/trigger
Terminal
curl -X POST https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/trigger \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": {
      "contact_id": "con_3munwNLaXKUARc6ff9wPtxKVq4A",
      "plan": "pro",
      "order_id": "ord_1042"
    }
  }'
JSON
{
  "message": "Automation trigger dispatched."
}

Výpis spuštění

Vrátí spuštění automatizace od nejnovějších. Každé spuštění je jeden průchod grafem, který zahájil spouštěč. Vyžaduje API klíč s oprávněním full.

GET/automations/{id}/runs

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Parametry dotazu

pageintegervýchozí: 1
Číslo stránky, od 1.
per_pageintegervýchozí: 25
Počet spuštění na stránce, od 1 do 100.
filter[status]string
Jen spuštění v tomto stavu: running, completed, failed nebo canceled.
filter[contact_id]string
Jen spuštění tohoto kontaktu (con_…). Spuštění kontaktu ve všech automatizacích najdete přes Výpis spuštění kontaktu.

Filtrovat můžete také přes key.condition=value podle status, event a created_at (například created_at.after=2026-10-01) a podle stejných klíčů řadit přes order a direction. Viz Filtrování.

Odpověď

dataobject[]
Spuštění na této stránce. Viz pole níže.
total_records, per_page, current_page, total_pagesinteger
Údaje o stránkování.

Každé spuštění má:

idstring
ID spuštění s předponou aur_.
automation_idstring
Automatizace (aut_…).
contact_idstring | null
Kontakt spuštění (con_…) v kontextu contact.
email_idstring | null
E-mail spuštění (em_…) v kontextu email.
event_idstring | null
ID zdrojové události, pokud ho obsah spouštěče má.
eventstring
Spouštěč, který spuštění zahájil, například contact.added_to_audience nebo system.manual.
payloadobject
V tomto výpisu vždy prázdný objekt. Pokud chcete přečíst obsah spouštěče, načtěte spuštění.
metaobject
V tomto výpisu vždy prázdný objekt. Pokud chcete přečíst metadata, například failure_reason, načtěte spuštění.
statusstring
running, completed, failed nebo canceled.
cancel_reasonstring | null
Proč se zrušené spuštění zastavilo: exit_condition, left_audience, canceled_by_user (nebo reason, který jste poslali), exited_by_api, exited_by_automation, automation_stopped nebo contact_deleted.
started_at, completed_at, created_at, updated_atstring | null
Časová razítka v UTC.
GET/automations/{id}/runs
Terminal
curl -G https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/runs \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  --data-urlencode "filter[status]=failed"
JSON
{
  "data": [
    {
      "id": "aur_3q6GdFk2eRSG093grI0v9e6REu8",
      "automation_id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
      "contact_id": "con_3munwNLaXKUARc6ff9wPtxKVq4A",
      "email_id": null,
      "event_id": null,
      "event": "contact.added_to_audience",
      "payload": {},
      "meta": {},
      "status": "failed",
      "started_at": "2026-10-03T14:12:40.551870+00:00",
      "completed_at": "2026-10-03T14:12:41.093355+00:00",
      "created_at": "2026-10-03T14:12:40.551870+00:00",
      "updated_at": "2026-10-03T14:12:41.093355+00:00"
    }
  ],
  "total_records": 1,
  "per_page": 25,
  "current_page": 1,
  "total_pages": 1
}

Načtení spuštění

Načte jedno spuštění automatizace včetně provedených kroků. Vyžaduje API klíč s oprávněním full.

GET/automations/{id}/runs/{run_id}

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).
run_idstringpovinné
ID spuštění (aur_…).

Odpověď

Vrací spuštění v poli data s poli popsanými na stránce Výpis spuštění a navíc s úplnými payload a meta, polem run_steps a polem waits.

payloadobject | null
Obsah spouštěče: data události ({ "object": { … } }), nebo obsah, který jste předali při ručním spuštění, s přidaným automation_id.
metaobject | null
source_event_id propojuje spuštění s událostí, která ho zahájila. Neúspěšná spuštění mohou mít failure_reason: insufficient_credits (3 kredity za spuštění nebylo možné naúčtovat), nebo run_timeout (spuštění bylo po 72 hodinách stále ve stavu running, aniž by čekalo na některém kroku). Zrušená spuštění mají cancel_reason a dokončená spuštění, která skončila předčasně, mají ended_by, například end_run_step, moved_to_automation nebo goal_not_met. Spuštění zahájená jinou automatizací mají depth a buď parent_run_id (zahájená krokem Start automation), nebo caused_by (zahájená změnou, kterou provedl krok).
run_stepsobject[]

Jedna položka za každý krok, ke kterému spuštění došlo:

  • step_id: ID kroku (aus_…) a k tomu step_key a action, tedy klíč a akce kroku.
  • status: running, waiting (krok wait nebo wait_until, který ještě neskončil), completed, failed, skipped (přeskočený, když spuštění přeskočilo k cíli nebo skončilo předčasně) nebo canceled.
  • outcome: výsledek, například poslední stav e-mailu odeslaného krokem send_email (delivered, loaded, clicked…), skipped u marketingového e-mailu pro odhlášený kontakt, matched, nebo not_matched u podmínky, matched, nebo timeout u wait_until a reached, nebo not_reached u cíle.
  • data: výsledek kroku. Například send_email vrací { "result": "email_queued", "email_oid": "em_…", "to": "…" }, condition vrací { "result": true, "branch": "yes" } a neúspěšné kroky vracejí { "error": "…" }.
  • started_at, completed_at, created_at.
waitsobject[]

Čekání spuštění v krocích wait_until (na událost nebo podmínku) a goal: id, step_key, kind (event, nebo condition), event, status (waiting, matched, timed_out nebo canceled), timeout_at, created_at a resolved_at.

Pokud automatizace nebo spuštění neexistuje, vrací 404.

GET/automations/{id}/runs/{run_id}
Terminal
curl https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/runs/aur_3q6GdFk2eRSG093grI0v9e6REu8 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "data": {
    "id": "aur_3q6GdFk2eRSG093grI0v9e6REu8",
    "automation_id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
    "contact_id": "con_3munwNLaXKUARc6ff9wPtxKVq4A",
    "email_id": null,
    "event_id": null,
    "event": "contact.added_to_audience",
    "payload": {
      "object": {
        "id": "sub_3Fh2pQx9LmZr4Wt7Nc0bVd8KsYe",
        "object": "subscriber",
        "subscribed": true,
        "audience": { "id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV", "name": "Newsletter" },
        "contact": { "id": "con_3munwNLaXKUARc6ff9wPtxKVq4A", "email": "ada@example.com" }
      }
    },
    "meta": { "source_event_id": "evt_3Kd8sWq1NzXc5Vb7Mt2LpRy0HgA" },
    "status": "running",
    "started_at": "2026-10-03T14:12:40.551870+00:00",
    "completed_at": null,
    "created_at": "2026-10-03T14:12:40.551870+00:00",
    "updated_at": "2026-10-03T14:12:40.551870+00:00",
    "run_steps": [
      {
        "step_id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
        "status": "completed",
        "data": {
          "result": "email_queued",
          "outcome": "accepted",
          "email_oid": "em_3Cp8cMgPskzB8tIlgUyNJkpDp9O",
          "to": "ada@example.com"
        },
        "started_at": "2026-10-03T14:12:40.702113+00:00",
        "completed_at": "2026-10-03T14:12:40.918540+00:00",
        "created_at": "2026-10-03T14:12:40.702113+00:00"
      },
      {
        "step_id": "aus_3vM0ORwEXCQcyS7rylfQBQEXjVk",
        "status": "waiting",
        "data": { "status": "waiting", "delayMs": 86400000, "seconds": 86400 },
        "started_at": "2026-10-03T14:12:41.004221+00:00",
        "completed_at": null,
        "created_at": "2026-10-03T14:12:41.004221+00:00"
      }
    ]
  }
}

Zrušení spuštění

Zruší spuštění, které je ještě ve stavu running. Kroky čekající v Time delay nebo Wait until se zruší, žádné další kroky se neprovedou a spuštění přejde do stavu canceled. Vyžaduje API klíč s oprávněním full.

Zrušená spuštění nelze obnovit. Pokud chcete zrušit všechna spuštění jednoho kontaktu v automatizaci, použijte Odebrání kontaktu z automatizace. Pokud chcete spuštění rušit automaticky, použijte podmínky ukončení.

POST/automations/{id}/runs/{run_id}/cancel

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).
run_idstringpovinné
ID spuštění (aur_…).

Parametry v těle požadavku

reasonstringvýchozí: canceled_by_user
Uloží se jako cancel_reason spuštění, nejvýše 200 znaků.

Odpověď

Vrací spuštění v data se status canceled a s cancel_reason. Pokud automatizace nebo spuštění neexistuje, vrací 404, a pokud spuštění neprobíhá, 422.

POST/automations/{id}/runs/{run_id}/cancel
Terminal
curl -X POST https://api.emailit.com/v2/automations/aut_3Mv8Xq2nKp5Lt/runs/aur_7Kp2Vx9mQt4Lw/cancel \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Customer asked to stop"}'

Odebrání kontaktu z automatizace

Zruší všechna spuštění této automatizace, která jsou pro jeden kontakt ještě ve stavu running, například z vašeho e-shopu, když je objednávka zaplacená. Spuštění dostanou stav canceled. Vyžaduje API klíč s oprávněním full.

Pokud chcete kontakty vyřazovat automaticky, když se něco stane, použijte místo toho podmínky ukončení.

POST/automations/{id}/exit

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Parametry v těle požadavku

contact_idstring
ID kontaktu (con_…). Pošlete tento parametr, nebo email.
emailstring
E-mailová adresa kontaktu.
reasonstringvýchozí: exited_by_api
Uloží se jako cancel_reason každého spuštění, nejvýše 200 znaků.

Odpověď

dataobject
automation_id, contact_id a canceled_runs, tedy ID zrušených spuštění. Prázdné, pokud kontakt žádná probíhající spuštění neměl.
messagestring
Například Canceled 1 run.

Bez contact_id nebo email vrací 400, pro neexistující automatizaci nebo kontakt 404.

POST/automations/{id}/exit
Terminal
curl -X POST https://api.emailit.com/v2/automations/aut_3Mv8Xq2nKp5Lt/exit \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "ada@example.com"}'

Výpis spuštění kontaktu

Vrátí posledních 100 spuštění jednoho kontaktu ve všech automatizacích, od nejnovějšího, každé s názvem automatizace. Vyžaduje API klíč s oprávněním full.

GET/automations/runs

Parametry dotazu

contact_idstring
ID kontaktu (con_…). Pošlete tento parametr, nebo email.
emailstring
E-mailová adresa kontaktu.
statusstring
Jen spuštění v tomto stavu: running, completed, failed nebo canceled.

Odpověď

dataobject[]
Spuštění ve stejném tvaru jako ve Výpisu spuštění, navíc s automation_name.

Bez contact_id nebo email vrací 400, pro neexistující kontakt 404.

GET/automations/runs
Terminal
curl "https://api.emailit.com/v2/automations/runs?email=ada@example.com&status=running" \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

Načtení statistik

Vrátí počty pro všechny kroky automatizace, s klíči podle klíčů kroků. Vyžaduje API klíč s oprávněním full.

GET/automations/{id}/stats

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).

Parametry dotazu

sincestring
Započítá jen provedení kroků vytvořená v tento čas nebo později. Datum a čas podle RFC 3339, například 2026-10-01T00:00:00Z.
untilstring
Započítá jen provedení kroků vytvořená v tento čas nebo dříve. Datum a čas podle RFC 3339.
run_ids[]string
Započítá jen tato spuštění (aur_…). Pro více spuštění parametr zopakujte.

Odpověď

Vrací data, objekt s jednou položkou pro každý klíč kroku. Kroky, ke kterým nedošlo žádné spuštění, mají total rovné 0.

totalinteger
Kolikrát spuštění ke kroku došla.
by_statusobject
Počty podle stavu kroku: running, waiting, completed, failed.
by_outcomeobject
Počty podle výsledku. send_email a forward_email: accepted a pak poslední stav e-mailu (delivered, loaded, clicked, bounced, failed, complained, unsubscribed, canceled). condition: matched, not_matched. experiment: klíč vybrané varianty. call_webhook: 2xx, 4xx, 5xx, timeout, network_error. Neúspěšné kroky: error.
funnelobject
Jen pro kroky send_email. Kumulativní počty: accepted zahrnuje každý e-mail, který se dostal dál, delivered zahrnuje načtené a prokliknuté e-maily a loaded zahrnuje prokliknuté. bounced, failed, complained a unsubscribed jsou prosté počty.
GET/automations/{id}/stats
Terminal
curl -G https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/stats \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -d since=2026-10-01T00:00:00Z
JSON
{
  "data": {
    "joined": { "total": 0, "by_status": {}, "by_outcome": {} },
    "welcome_email": {
      "total": 412,
      "by_status": { "completed": 409, "failed": 3 },
      "by_outcome": { "delivered": 251, "loaded": 98, "clicked": 41, "bounced": 19, "error": 3 },
      "funnel": {
        "accepted": 390,
        "delivered": 390,
        "loaded": 139,
        "clicked": 41,
        "bounced": 19,
        "failed": 0,
        "complained": 0,
        "unsubscribed": 0
      }
    },
    "wait_1_day": {
      "total": 409,
      "by_status": { "completed": 352, "waiting": 57 },
      "by_outcome": {}
    },
    "is_free_user": {
      "total": 352,
      "by_status": { "completed": 352 },
      "by_outcome": { "matched": 270, "not_matched": 82 }
    },
    "upgrade_tips": {
      "total": 270,
      "by_status": { "completed": 270 },
      "by_outcome": { "accepted": 12, "delivered": 180, "loaded": 61, "clicked": 17 },
      "funnel": {
        "accepted": 270,
        "delivered": 258,
        "loaded": 78,
        "clicked": 17,
        "bounced": 0,
        "failed": 0,
        "complained": 0,
        "unsubscribed": 0
      }
    },
    "done": {
      "total": 82,
      "by_status": { "completed": 82 },
      "by_outcome": {}
    }
  }
}

Načtení statistik kroků

Vrátí počty pro jeden krok automatizace. Vyžaduje API klíč s oprávněním full. Pole jsou stejná jako na stránce Načtení statistik.

GET/automations/{id}/steps/{step_key}/stats

Parametry v cestě

idstringpovinné
ID automatizace (aut_…).
step_keystringpovinné
key kroku, například welcome_email.

Parametry dotazu

sincestring
Započítá jen provedení kroků vytvořená v tento čas nebo později. Datum a čas podle RFC 3339.
untilstring
Započítá jen provedení kroků vytvořená v tento čas nebo dříve. Datum a čas podle RFC 3339.

Odpověď

Vrací data s poli total, by_status, by_outcome a u kroků send_email také funnel. Pokud automatizace nebo klíč kroku neexistuje, vrací 404.

GET/automations/{id}/steps/{step_key}/stats
Terminal
curl https://api.emailit.com/v2/automations/aut_3xqC9YD79FZZA36uTekWTBO1ghe/steps/welcome_email/stats \
  -H "Authorization: Bearer $EMAILIT_API_KEY"
JSON
{
  "data": {
    "total": 412,
    "by_status": { "completed": 409, "failed": 3 },
    "by_outcome": { "delivered": 251, "loaded": 98, "clicked": 41, "bounced": 19, "error": 3 },
    "funnel": {
      "accepted": 390,
      "delivered": 390,
      "loaded": 139,
      "clicked": 41,
      "bounced": 19,
      "failed": 0,
      "complained": 0,
      "unsubscribed": 0
    }
  }
}

Byla tato stránka užitečná?

Děkujeme za zpětnou vazbu.

Děkujeme, čteme každou zprávu.