API

Odeslání pomocí šablony

Uložené tělo dodá zprávu; požadavek dodá obálku a hodnoty.

POSTapi.openemail.uk/templates/{id}/send

Spustí skutečné volání proti vašemu pracovnímu prostoru, s vaším vlastním klíčem.

POST /templates/{id}/send

Uložené tělo dodá zprávu; požadavek dodá obálku a hodnoty.

Příklad

Vyžaduje templates:write A ZÁROVEŇ emails:send. Hlavičku Idempotency-Key respektuje přesně tak jako POST /emails.

curl

curl -X POST "$OE/templates/order-shipped/send" -H "$AUTH" \  -H "Content-Type: application/json" -H "Idempotency-Key: order:AC-4192:shipped" \  -d '{    "from": "Acme Dispatch <[email protected]>",    "to": ["[email protected]"],    "version": 5,    "props": { "orderId": "AC-4192", "customer": "Ada" }  }'

Odpověď

{  "object": "email",  "id": "msg_c5f21cc6…",  "status": "queued",  "from": "[email protected]",  "subject": "Order AC-4192 is on its way",  "template": { "id": "order-shipped", "version": 5 }}

Oba scopy, a ani jeden není nadbytečný: templates:write proto, že volající sahá na uložené tělo, emails:send proto, že pošta opouští pracovní prostor. Klíč, který smí odesílat vlastní těla, stále nemůže odeslat cizí šablonu.

Ve všem automatizovaném zafixujte version. Bez ní vyhodnotíte to, co je v daný okamžik publikované, což je přesně to, co chcete, když text vlastní někdo jiný, a přesně to, co nechcete ráno, kdy ho přepíše.

subject přebije vlastní předmět šablony jen pro tuto zprávu a cancellableForSeconds, tracking a tags se chovají úplně stejně jako u běžného odeslání.

POST /emails přijímá pole template, které dělá totéž, pro volajícího, který už tam zprávy sestavuje. Tento endpoint existuje proto, aby sáhnutí na uložené tělo nevyžadovalo dodat tvar zprávy, kterou nesestavujete.

Kdy je odeslání odmítnuto

Props jsou smlouva, ne doporučení, a každé selhání níže nastane dřív, než se cokoli odešle. Ta druhá možnost, tedy zpráva, která odejde s prázdným místem tam, kde mělo být číslo objednávky, se nikde neohlásí a nedá se vzít zpět.

Kód	Stav	Co se stalo
`resource_not_found`	404	Na tomto připojení není žádná šablona s tímto id ani slugem.
`template_not_published`	422	Existuje a nikdy nebyla publikována, nebo je verze, kterou jste uvedli, stále konceptem.
`template_version_not_found`	422	Zafixovali jste `version`, kterou tato šablona nikdy neměla.
`missing_template_prop`	422	Prop deklarovaný jako `required` chyběl, byl null nebo prázdný.
`unknown_template_prop`	422	Předali jste klíč, který daná verze nedeklaruje. Zpráva vyjmenuje ty, které deklaruje.
`unknown_template_slot`	422	Totéž, ale pro slot.
`invalid_template_prop`	422	Hodnota, která není string, number ani boolean. Object ani array nelze dosadit do HTML.

param je u nich template.props.<key>, takže klient může ukázat na pole, které zadal špatně, aniž by parsoval text zprávy.