Pāriet uz dokumentāciju
API

Veidņu saraksts

Katra veidne savienojumā, jaunākās vispirms, ar keyset lapošanu.

GETapi.openemail.uk/templates

Izpilda īstu izsaukumu pret jūsu darbvietu, ar jūsu paša atslēgu.

GET /templates

Katra veidne savienojumā, jaunākās vispirms, ar keyset lapošanu.

Divi dzinēji

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

Veidne ir saturs, kas saglabāts vienreiz un nosūtīts daudzkārt, un tā pieder SAVIENOJUMAM, nevis tam, kas to uzrakstīja. Darbvietas atslēga redz tās pašas veidnes, ko kolēģis, un autora konta dzēšana tās līdzi neaizrauj.

engine: "blocks" glabā koku, kura mezglu veidi ir @react-email/components eksporti (Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock un CodeInline) un kura props ir šo pašu komponentu props. Tas tiek validēts ienākot, tāpēc slikts mezgls ir 422 tajā izsaukumā, kas to ierakstīja, nevis salūzusi vēstule vēlāk.

engine: "html" glabā marķējumu, kas jums jau ir, sanitizētu vienreiz, kad versija tiek publicēta. Pēc šī jāsniedzas tad, ja jūsu veidnes ir react-email komponenti jūsu paša repozitorijā: atveidojiet komponentu ar @react-email/render savā būvējumā un nosūtiet rezultātu. JSX galapunkta nav un nebūs. API pieņem HTML, jo HTML ir tas, ko lasa pasta klients, un izsaucēja komponenta izpilde nopirktu smilškasti, kas nevienam nav vajadzīga.

Deklarēts kāAizpildaJa sūtot trūkst
`slots`tas, kurš rediģē veidniatveidojas paša slota default
`props`tas, kurš sūtamissing_template_prop, 422, un neviena vēstule neaiziet

Abi tiek rakstīti kā {{key}} gan saturā, gan tēmā, un abiem ir kind (text, url vai image), kas izšķir, kā vērtība tiek ekranēta, to aizvietojot. Atslēga, ko neviens nedeklarē, krīt publicējot; url vērtība, kuras shēma nav http, https vai mailto, tiek atteikta, nevis atveidota.

Publicēta versija ir iesaldēta. Publicētas veidnes satura rediģēšana kaļ jaunu melnrakstu, nevis maina to, ko izšķir dzīvās sūtīšanas, tāpēc kolēģis, kas pārraksta tekstu, nevar mainīt to, ko jūsu kods jau sūta, un version piestiprināšana nozīmē, ka viņš to nevar mainīt arī publicējot.

Piemērs

Nepieciešams templates:read. limit sniedzas līdz 100, status sašaurina uz draft, active vai archived, un cursor ir necaurspīdīgs, tāpēc padodiet atpakaļ to nextCursor, ko saņēmāt, nevis būvējiet savu.

curl
curl "$OE/templates?limit=25&status=active" -H "$AUTH"
Atbilde
{  "object": "list",  "data": [    {      "object": "template",      "id": "tpl_9c1f0a4b7e05d3862c1f0a44",      "name": "Order shipped",      "slug": "order-shipped",      "description": null,      "status": "active",      "publishedVersion": 3,      "latestVersion": 4,      "createdAt": "2026-08-01T09:12:44.000Z",      "updatedAt": "2026-08-28T16:03:10.000Z"    }  ],  "hasMore": false,  "nextCursor": null}

publishedVersion ir tas, ko izšķir sūtīšana bez version, un latestVersion ir melnraksts, kas sēž tam virsū. Ja tie atšķiras, kāds ir rediģējis un nav publicējis. Tā nav kļūda, un to ir vērts parādīt izvietošanas žurnālā.

Rinda ir metadati. Deklarētie slots un props atgriežas no atsevišķas iegūšanas, un tieši to izsaukumu veic, kad jāzina, ko veidnei padot.