Dërgo me një shabllon
Trupi i ruajtur jep mesazhin; kërkesa jep zarfin dhe vlerat.
Ekzekuton thirrjen reale kundrejt hapësirës suaj të punës, me çelësin tuaj.
POST /templates/{id}/send
Trupi i ruajtur jep mesazhin; kërkesa jep zarfin dhe vlerat.
Shembull
Kërkon templates:write DHE emails:send. E respekton Idempotency-Key pikërisht siç e bën POST /emails.
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" } }'{ "object": "email", "id": "msg_c5f21cc6…", "status": "queued", "from": "[email protected]", "subject": "Order AC-4192 is on its way", "template": { "id": "order-shipped", "version": 5 }}Të dy fushëveprimet, dhe asnjëri nuk është i tepërt: templates:write sepse thirrësi po prek një trup të ruajtur, emails:send sepse posta del nga hapësira e punës. Një çelës që mund të dërgojë trupat e vet prapë nuk mund të dërgojë shabllonin e dikujt tjetër.
Fiksoni version në çdo gjë të automatizuar. I lënë jashtë, ju zgjidhni çfarëdo që është e publikuar në atë çast, që është ajo çfarë doni kur tekstin e zotëron dikush tjetër dhe jo ajo çfarë doni në mëngjesin kur ai e rishkruan.
subject mbizotëron mbi atë të vetë shabllonit vetëm për këtë mesazh, dhe cancellableForSeconds, tracking e tags sillen pikërisht si në një dërgim të zakonshëm.
POST /emails pranon një fushë template që bën të njëjtën gjë, për një thirrës që i ndërton tashmë mesazhet atje. Ky endpoint ekziston që prekja e një trupi të ruajtur të mos kërkojë dhënien e formës së një mesazhi që nuk po e krijoni ju.
Kur një dërgim refuzohet
Props-et janë një kontratë e jo një sugjerim, dhe çdo dështim më poshtë ndodh para se të nisë gjëkafshë. Alternativa, një mesazh që del me një bosh aty ku duhej numri i porosisë, nuk raportohet nga asgjë dhe nuk mund të tërhiqet.
| Kodi | Statusi | Çfarë ndodhi |
|---|---|---|
| `resource_not_found` | 404 | Asnjë shabllon në këtë lidhje me atë id ose slug. |
| `template_not_published` | 422 | Ekziston dhe nuk është publikuar kurrë, ose versioni që emërtuat është ende draft. |
| `template_version_not_found` | 422 | Fiksuat një version që ky shabllon nuk e ka pasur kurrë. |
| `missing_template_prop` | 422 | Një prop i deklaruar required mungonte, ishte null ose bosh. |
| `unknown_template_prop` | 422 | Kaluat një çelës që versioni nuk e deklaron. Mesazhi emërton ata që i deklaron. |
| `unknown_template_slot` | 422 | E njëjta gjë, për një slot. |
| `invalid_template_prop` | 422 | Një vlerë që nuk është string, number apo boolean. Një object ose një array nuk mund të zëvendësohet brenda HTML-së. |
param te këto është template.props.<key>, ndaj një klient mund të tregojë fushën që gaboi pa e analizuar mesazhin.