API

Modèles

Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.

Opérations

A body authored once and sent many times, scoped to the workspace rather than to whoever wrote it.

Two engines, for two different people. blocks is a validated tree whose node kinds are the exports of @react-email/components, checked at its input and rendered here. html is markup you rendered yourself (a react-email component run through @react-email/render in your own build, a design-tool export, a hand-written table layout), sanitised once when the version is published. We cannot execute your JSX: workerd has no eval and no transpiler, so the render happens where the component lives and what crosses the wire is HTML.

Versions are immutable once published, and that is the feature rather than bookkeeping. Editing a published template mints a new draft; live sends keep resolving the frozen version until somebody publishes again. Without it, renaming a slot in the editor would silently start sending mail with a blank where the order number was: no error, nothing in a log, and no way to recall it. With it, the published version keeps saying orderId and the caller finds out from a 422 on their own schedule.

POST /emails also takes a template field, so a caller already composing a message need not switch endpoints to reach a stored body.

GET`/templates`

List templates

templates:readLit

Each row carries the PUBLISHED version's subject, engine, slots and props, so a caller can see what to pass a template without a request per row. A template with nothing published carries none of them and reports publishedVersion: null.

Requires the templates:read scope.

Paramètres de requête

limitinteger: Defaults to 25. The bound lives in the service, so it is not in the schema.
Au moins 1Au plus 100
cursorstring: The nextCursor you were handed, passed back as it came and never one you build. It is opaque: it holds the sort it was handed out under and where the last template sat in that order, so a template deleted between pages never breaks the walk. Keyset on whichever sort you asked for, so a template edited mid-pagination under the default sort moves to the front and can be seen twice. A value this list did not hand out, or one handed out under another sort, is a 400 invalid_cursor.
De 1 à 2048 caractères
statusstring: Narrows to drafts, active or archived templates. Omit for all three. draft here is the template's own status, not "has an unpublished draft", which every template has.
L'un de"draft""active""archived"
searchstring: Matches the name, the slug, the description, the published version's subject and the id. Every word has to appear, and each matches loosely: case, accents and separators are ignored and part of a longer word counts. When nothing matches exactly, close spellings are returned instead. % and _ are taken literally rather than as wildcards, so pasting a name in cannot turn into a scan.
Jusqu'à 200 caractères
sortstring: The order, and the field the cursor keys on. updated-newest is the default and the one the console lists under. Keep it the same while you page, because a cursor handed out under one sort is refused under another.
L'un de"updated-newest""updated-oldest""created-newest""created-oldest""name""name-reversed"

Retourne

200TemplateList

A page, most recently updated first.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.list()templates.listAll()templates.iterate()
CLI: openemail templates list
MCP: listTemplates

POST`/templates`

Create a template

templates:writeModifie des données

Creates the template and its version 1. publish: true freezes that version there and then; without it you get a DRAFT, and a draft is not sendable. POST /templates/{id}/send answers template_not_published until somebody publishes it.

The engine follows what you send: html when you post html, blocks otherwise, and engine is only worth stating to be explicit about it. document, slots and props are unconstrained in this schema on purpose. One validator owns the block tree so that REST, tRPC and MCP cannot each hold a slightly different copy of it, and a bad node comes back as a 422 naming its path rather than as a schema error here.

Requires the templates:write scope.

Corps de la requête

namestringObligatoire

Display name, 1 to 100 characters after trimming and unique per workspace.

De 1 à 100 caractères

slugstring

Stable handle of lowercase letters, digits and hyphens, at most 64 characters. Derived from name when omitted.

Jusqu'à 64 caractèresMotif^[a-z0-9][a-z0-9-]*$

descriptionstring

Free text note, at most 500 characters.

Peut être nullJusqu'à 500 caractères

publishboolean

Compiles and publishes version 1 immediately. Defaults to false, which leaves a draft.

Par défautfalse

starterstring

A starter slug from listStarters, which seeds the subject and the body. Anything you send yourself wins over the starter, and an unknown slug is a 404.

Jusqu'à 64 caractères

enginestring

blocks or html. Inferred from whether html is present.

L'un de"blocks""html"

subjectstring

Subject line with optional {{placeholders}}, at most 998 characters and free of line breaks.

Jusqu'à 998 caractères

documentobject

The body of a blocks template: the block tree plus the page settings wrapped around it. An html template has none of this and carries html instead.

It REPLACES wholesale. A PATCH that sends document sends the whole document, so a call that rebuilds body and omits fonts drops the fonts. Read the head with GET /templates/{id} (or an older revision with GET /templates/{id}/versions/{version}), change what you mean to change, and post the result back.

bodyobject[]Obligatoire: The blocks, in order, 500 at most across the whole tree. Each is an object with a kind of Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock, CodeInline and the fields that kind takes; Section, Row, Column and Container nest through their own children, 8 deep at most.
Jusqu'à 500 éléments
previewstring: Preview text: the line most mail clients show after the subject in the list. Left out, the client picks the first words of the body for you, which is usually a greeting.
Jusqu'à 256 caractères
tailwindboolean: Read Tailwind class names on the blocks and inline them at publish. Off by default, because a template written without them gains nothing and pays the compile.
Par défautfalse
fontsTemplateFont[]: Web fonts to load, 8 at most. This is the only place fonts are declared; a font-family on a block refers to a family named here or to one already on the reader's machine.
Jusqu'à 8 éléments
styleobject: Page style for the whole message, as a CSS property bag in camelCase or kebab-case, for example { "backgroundColor": "#f5f5f5" }. Only the properties mail clients honour are accepted, and a rejected one is a 422 naming itself and listing what is allowed.
slotsTemplateSlot[]: The same list as the top-level slots on a create or a PATCH. Sending both is allowed and the top-level one wins.
propsTemplateProp[]: The same list as the top-level props, with the same precedence.

htmlstring

Pre-rendered markup for the html engine. Required for it, at most 1,000,000 characters.

Jusqu'à 1000000 caractères

slotsTemplateSlot[]

Replaces the whole slot list. Sending a shorter list DELETES the slots you left out, so read them first and send them all back. Omit the field entirely to leave them alone.

propsTemplateProp[]

Replaces the whole prop list, with the same rule: what you leave out is gone, and a send that was passing it starts failing. Omit the field to leave them alone.

Retourne

201Template

Created, with version 1.

Erreurs

409: template_name_taken or template_slug_taken. Both are per workspace.
422: invalid_template (with param naming the offending path, down to the block) or workspace_limit_reached when the workspace is at its template limit.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.create()
CLI: openemail templates create
MCP: createTemplate

GET`/templates/fonts`

List the web fonts a template can load

templates:readLit

A template loads a web font by naming a family and the url it is served from, and 17 families are accepted: DM Sans, Inter, Roboto, Open Sans, Lato, Montserrat, Poppins, Nunito, Work Sans, Source Sans 3, IBM Plex Sans, Merriweather, Playfair Display, Instrument Serif, JetBrains Mono, DM Mono, Geist Mono. This is that list, with the exact url each one takes.

The list is closed on purpose. A font file is fetched by the reader's mail client the moment the message is opened, so a url pointing anywhere else would report opens to whoever runs that host, silently and regardless of what the workspace has open tracking set to. A webFont.url that is not the one this endpoint gives for its family is a 422 invalid_template naming the font.

One template may load 8 of them. A font whose family is not here still renders: leave webFont out and the family falls back to fallbackFontFamily, which is what Gmail and Outlook on Windows do with every web font anyway.

Static, not workspace data, so the same answer comes back for every key.

Requires the templates:read scope.

Retourne

200TemplateFontList

The 17 fonts, in the order the console offers them.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.listFonts()
CLI: openemail templates list-fonts

GET`/templates/starters`

List the starter designs

templates:readLit

The same catalogue the console offers when somebody starts a template, so an integration and a person begin from the same designs rather than from two divergent lists.

Not paginated and not workspace data: these ship with the product. The slug is what POST /templates takes as starter and what POST /templates/{id}/content takes to re-skin an existing template. Bodies and previews are on the single retrieval, because twenty rendered emails is not a list payload.

Requires the templates:read scope.

Retourne

200TemplateStarterList

Every starter, bodies left out.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.listStarters()
CLI: openemail templates list-starters
MCP: getTemplateStarterlistTemplateStarters

GET`/templates/starters/{slug}`

Retrieve one starter

templates:readLit

Adds the two heavy fields: document, the block tree, and preview, the starter rendered with its placeholders left visible.

The document is here so a client can edit a starter before creating anything from it. When you do not need to, starter on the create does the seeding server side in one call.

Requires the templates:read scope.

Paramètres de chemin

slugstringObligatoire: A starter slug exactly as GET /templates/starters reports it. Starters are part of the product rather than workspace data, so the same slugs answer for every key.

Retourne

200TemplateStarterDetail

The starter with its block tree and a rendered preview.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.getStarter()
CLI: openemail templates get-starter
MCP: getTemplateStarterlistTemplateStarters

POST`/templates/render`

Render a body that is not stored

templates:readLit

Compiles content you pass in and hands back what a message built from it would carry. No template is created, none is read, and nothing is sent. It is what the web editor calls while somebody types, and the way to check a design in CI before it becomes a template at all.

It takes exactly what a create takes as content, plus values for the placeholders. Lenient like a preview: an unfilled key comes back in warnings rather than refusing, because a body being rendered is usually a body being written. mark: true leaves every placeholder as {{key}}, which is how an editor shows an author what is a variable.

Needs only templates:read, since nothing is written, and it is the one templates path that names no template.

Requires the templates:read scope.

Corps de la requête

enginestring

Defaults to html when html is sent and blocks otherwise.

L'un de"blocks""html"

subjectstring

The subject to render, at most 998 characters.

Jusqu'à 998 caractères

documentobject

The body of a blocks template: the block tree plus the page settings wrapped around it. An html template has none of this and carries html instead.

bodyobject[]Obligatoire: The blocks, in order, 500 at most across the whole tree. Each is an object with a kind of Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock, CodeInline and the fields that kind takes; Section, Row, Column and Container nest through their own children, 8 deep at most.
Jusqu'à 500 éléments
previewstring: Preview text: the line most mail clients show after the subject in the list. Left out, the client picks the first words of the body for you, which is usually a greeting.
Jusqu'à 256 caractères
tailwindboolean: Read Tailwind class names on the blocks and inline them at publish. Off by default, because a template written without them gains nothing and pays the compile.
Par défautfalse
fontsTemplateFont[]: Web fonts to load, 8 at most. This is the only place fonts are declared; a font-family on a block refers to a family named here or to one already on the reader's machine.
Jusqu'à 8 éléments
styleobject: Page style for the whole message, as a CSS property bag in camelCase or kebab-case, for example { "backgroundColor": "#f5f5f5" }. Only the properties mail clients honour are accepted, and a rejected one is a 422 naming itself and listing what is allowed.
slotsTemplateSlot[]: The same list as the top-level slots on a create or a PATCH. Sending both is allowed and the top-level one wins.
propsTemplateProp[]: The same list as the top-level props, with the same precedence.

htmlstring

The markup for the html engine, at most 1,000,000 characters.

Jusqu'à 1000000 caractères

slotsTemplateSlot[]

Replaces the whole slot list. Sending a shorter list DELETES the slots you left out, so read them first and send them all back. Omit the field entirely to leave them alone.

propsTemplateProp[]

Replaces the whole prop list, with the same rule: what you leave out is gone, and a send that was passing it starts failing. Omit the field to leave them alone.

markboolean

Leaves placeholders as {{key}} rather than substituting them.

valuesobject

propsRecord<string, any>
slotsRecord<string, any>

Retourne

200TemplateRender

The rendered subject, HTML and text.

Erreurs

422: invalid_template, with param naming the offending path.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.render()
CLI: openemail templates render
MCP: renderTemplate

GET`/templates/{id}`

Retrieve a template

templates:readLit

latest is the head (the current draft, or the published version when nothing has been edited since), and it is the only place document and html are returned in full. The template's own subject, engine, slots and props still describe the PUBLISHED version, which is what a send would use, so the two disagree exactly while somebody is mid-edit.

Requires the templates:read scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Retourne

200object

The template, with its head version in full.

objectstring: L'un de"template"
idstring: The durable handle, tpl_ + 24 hex.
namestring
slugstring: Derived from the name when the template is created and never re-derived on rename, so retitling "Order shipped" to "Dispatch confirmation" cannot 404 an integration that has been sending against it. This is the handle to pin in code; every path taking an {id} takes it too.
descriptionstring: Peut être null
statusstring: Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.
L'un de"draft""active""archived"
publishedVersioninteger: The revision a live send resolves to. Null means nothing has been published and the template cannot be sent. A send is refused with template_not_published rather than quietly going out as whatever the draft currently says.
Peut être null
latestVersioninteger: The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.
subjectstring: The published version's, and absent when nothing is published. Carries {{placeholders}} filled from the same values the body uses, so it is versioned with the body rather than stored on the template.
enginestring: blocks is a validated tree over the exports of @react-email/components, checked at its input. html is markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reason subject is: it is a property of a version, not of the template.
L'un de"blocks""html"
slotsTemplateSlot[]: The published version's declarations. Absent when nothing is published.
propsTemplateProp[]: What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.
createdAtstring: Formatdate-time
updatedAtstring: Formatdate-time
latestTemplateVersion

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.get()
CLI: openemail templates get
MCP: getTemplate

PATCH`/templates/{id}`

Update a template

templates:writeModifie des données

Metadata (name, description, status) changes the template in place. Anything touching the body (subject, document, html, slots, props, engine) writes into the DRAFT, and mints version N+1 when the head is already published. Nothing here changes what a live send resolves to: that only moves when somebody publishes.

expectedVersion is the version you read before editing. Supply it and a concurrent edit is a 409 instead of a silent overwrite, which is what an automated writer wants; omit it and the last write wins, which is fine for one person in one tab.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Corps de la requête

namestring

Replacement name, 1 to 100 characters and unique per workspace. The slug does not follow it.

De 1 à 100 caractères

slugstring

Replacement slug of lowercase letters, digits and hyphens, at most 64 characters. Anything pinning the old slug starts getting 404s, and taking another template's slug is a 409 template_slug_taken.

Jusqu'à 64 caractèresMotif^[a-z0-9][a-z0-9-]*$

descriptionstring

Replacement note of at most 500 characters, or null to clear it.

Peut être nullJusqu'à 500 caractères

statusstring

Archives or reactivates the template. It cannot be set back to draft.

L'un de"active""archived"

expectedVersioninteger

The head version number you edited from. A mismatch is a 409 version_conflict and nothing is written.

Plus de 0

enginestring

Switches between blocks and html. Switching to html needs html supplied or already stored.

L'un de"blocks""html"

subjectstring

Replacement subject, at most 998 characters and free of line breaks.

Jusqu'à 998 caractères

documentobject

The body of a blocks template: the block tree plus the page settings wrapped around it. An html template has none of this and carries html instead.

bodyobject[]Obligatoire: The blocks, in order, 500 at most across the whole tree. Each is an object with a kind of Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock, CodeInline and the fields that kind takes; Section, Row, Column and Container nest through their own children, 8 deep at most.
Jusqu'à 500 éléments
previewstring: Preview text: the line most mail clients show after the subject in the list. Left out, the client picks the first words of the body for you, which is usually a greeting.
Jusqu'à 256 caractères
tailwindboolean: Read Tailwind class names on the blocks and inline them at publish. Off by default, because a template written without them gains nothing and pays the compile.
Par défautfalse
fontsTemplateFont[]: Web fonts to load, 8 at most. This is the only place fonts are declared; a font-family on a block refers to a family named here or to one already on the reader's machine.
Jusqu'à 8 éléments
styleobject: Page style for the whole message, as a CSS property bag in camelCase or kebab-case, for example { "backgroundColor": "#f5f5f5" }. Only the properties mail clients honour are accepted, and a rejected one is a 422 naming itself and listing what is allowed.
slotsTemplateSlot[]: The same list as the top-level slots on a create or a PATCH. Sending both is allowed and the top-level one wins.
propsTemplateProp[]: The same list as the top-level props, with the same precedence.

htmlstring

Replacement markup for the html engine, at most 1,000,000 characters.

Jusqu'à 1000000 caractères

slotsTemplateSlot[]

Replaces the whole slot list. Sending a shorter list DELETES the slots you left out, so read them first and send them all back. Omit the field entirely to leave them alone.

propsTemplateProp[]

Replaces the whole prop list, with the same rule: what you leave out is gone, and a send that was passing it starts failing. Omit the field to leave them alone.

Retourne

200object

Saved. latest is the draft this edit wrote into.

objectstring: L'un de"template"
idstring: The durable handle, tpl_ + 24 hex.
namestring
slugstring: Derived from the name when the template is created and never re-derived on rename, so retitling "Order shipped" to "Dispatch confirmation" cannot 404 an integration that has been sending against it. This is the handle to pin in code; every path taking an {id} takes it too.
descriptionstring: Peut être null
statusstring: Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.
L'un de"draft""active""archived"
publishedVersioninteger: The revision a live send resolves to. Null means nothing has been published and the template cannot be sent. A send is refused with template_not_published rather than quietly going out as whatever the draft currently says.
Peut être null
latestVersioninteger: The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.
subjectstring: The published version's, and absent when nothing is published. Carries {{placeholders}} filled from the same values the body uses, so it is versioned with the body rather than stored on the template.
enginestring: blocks is a validated tree over the exports of @react-email/components, checked at its input. html is markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reason subject is: it is a property of a version, not of the template.
L'un de"blocks""html"
slotsTemplateSlot[]: The published version's declarations. Absent when nothing is published.
propsTemplateProp[]: What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.
createdAtstring: Formatdate-time
updatedAtstring: Formatdate-time
latestTemplateVersion

Erreurs

409: version_conflict, template_name_taken or template_slug_taken.

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.update()
CLI: openemail templates update
MCP: updateTemplate

DELETE`/templates/{id}`

Delete a template

templates:writeSupprime

Takes every version with it. Mail already sent is untouched (a send stores what it rendered), but anything still posting to this id starts getting 404s, and there is no undo. PATCH with status: "archived" is the reversible version of this.

A tombstone rather than a 204, matching the rest of the API: the id comes back so a log line can name what went.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Retourne

200object

Deleted.

objectstring: L'un de"template"
idstring
deletedboolean: L'un detrue

Erreurs

409: template_in_use: a broadcast that is scheduled or queued still names this template. Cancel it, or wait until it starts sending.

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.delete()
CLI: openemail templates delete
MCP: deleteTemplate

POST`/templates/{id}/duplicate`

Copy a template

templates:writeModifie des données

Creates a separate template from the HEAD of this one: same subject, body, slots, props and description, at version 1 and always a DRAFT, whatever the source had published. A copy is therefore never sendable by accident.

Nothing links the copy to the source afterwards, which is what makes this the safe way to try a redesign of a template that is sending in production.

name is optional. Left out, the source name is reused, and since a name is unique per workspace the server appends a number until one is free, up to twenty. A name you send that is taken is treated the same way, so a nightly copy keeps working rather than failing on the second run.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Corps de la requête

namestring: The name for the copy, 1 to 100 characters. Omit it to reuse the source name with a number appended.
De 1 à 100 caractères

Retourne

201object

The new template, at version 1 as a draft.

objectstring: L'un de"template"
idstring: The durable handle, tpl_ + 24 hex.
namestring
slugstring: Derived from the name when the template is created and never re-derived on rename, so retitling "Order shipped" to "Dispatch confirmation" cannot 404 an integration that has been sending against it. This is the handle to pin in code; every path taking an {id} takes it too.
descriptionstring: Peut être null
statusstring: Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.
L'un de"draft""active""archived"
publishedVersioninteger: The revision a live send resolves to. Null means nothing has been published and the template cannot be sent. A send is refused with template_not_published rather than quietly going out as whatever the draft currently says.
Peut être null
latestVersioninteger: The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.
subjectstring: The published version's, and absent when nothing is published. Carries {{placeholders}} filled from the same values the body uses, so it is versioned with the body rather than stored on the template.
enginestring: blocks is a validated tree over the exports of @react-email/components, checked at its input. html is markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reason subject is: it is a property of a version, not of the template.
L'un de"blocks""html"
slotsTemplateSlot[]: The published version's declarations. Absent when nothing is published.
propsTemplateProp[]: What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.
createdAtstring: Formatdate-time
updatedAtstring: Formatdate-time
latestTemplateVersion

Erreurs

409: template_name_taken: every name from the base to the base plus 20 is in use.
422: workspace_limit_reached: the workspace is at its template limit, and nothing was copied.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.duplicate()
CLI: openemail templates duplicate
MCP: duplicateTemplate

POST`/templates/{id}/content`

Replace the design

templates:writeSupprime

Swaps the whole body for a starter design or for another template's, keeping this template's identity: the id, slug, name, description and status do not move, and neither does what a live send resolves to.

The write lands where a body edit lands. A draft head is overwritten in place; a published head mints version N+1 as a draft. Sends keep using the published version until somebody publishes, which is what makes this safe to call on a template that is sending.

Name exactly one source. starter takes a slug from GET /templates/starters; fromTemplateId takes another template in this workspace, whose published version is copied when it has one and whose draft is copied otherwise. A source in another workspace is a 404 like anything else, and the template naming itself is a 422.

The new body brings the source's slots and props with it and replaces the declarations wholesale, so a send that passed the old props can start being refused. Read the response before publishing.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Corps de la requête

starterstring: A starter slug from listStarters. Mutually exclusive with fromTemplateId.
Jusqu'à 64 caractères
fromTemplateIdstring: Another template in this workspace to borrow the design from, by id or slug. Mutually exclusive with starter.
De 1 à 128 caractères
expectedVersioninteger: The head version you read before replacing. A mismatch is a 409 version_conflict and nothing is written.
Plus de 0

Retourne

200object

Replaced. latest is the version this call wrote into.

objectstring: L'un de"template"
idstring: The durable handle, tpl_ + 24 hex.
namestring
slugstring: Derived from the name when the template is created and never re-derived on rename, so retitling "Order shipped" to "Dispatch confirmation" cannot 404 an integration that has been sending against it. This is the handle to pin in code; every path taking an {id} takes it too.
descriptionstring: Peut être null
statusstring: Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.
L'un de"draft""active""archived"
publishedVersioninteger: The revision a live send resolves to. Null means nothing has been published and the template cannot be sent. A send is refused with template_not_published rather than quietly going out as whatever the draft currently says.
Peut être null
latestVersioninteger: The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.
subjectstring: The published version's, and absent when nothing is published. Carries {{placeholders}} filled from the same values the body uses, so it is versioned with the body rather than stored on the template.
enginestring: blocks is a validated tree over the exports of @react-email/components, checked at its input. html is markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reason subject is: it is a property of a version, not of the template.
L'un de"blocks""html"
slotsTemplateSlot[]: The published version's declarations. Absent when nothing is published.
propsTemplateProp[]: What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.
createdAtstring: Formatdate-time
updatedAtstring: Formatdate-time
latestTemplateVersion

Erreurs

409: version_conflict: another writer moved the head since your read.
422: invalid_template: no source was named, both were, or the target was named as its own source.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.replaceContent()
CLI: openemail templates replace-content
MCP: replaceTemplateContent

GET`/templates/{id}/versions`

List versions

templates:readLit

Bodies are omitted here. document and html come back on a retrieval or a publish, because a list of twenty block trees is a payload nobody asked for. What each version DECLARES (slots, props, subject) is present, which is what makes this the endpoint for "what would pinning version 3 commit me to".

To read one old body, GET the version itself at /templates/{id}/versions/{version}. That is the call for a diff against today's draft, and it does not disturb the head the way a restore does.

Requires the templates:read scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Paramètres de requête

limitinteger: Rows per page, 1 to 100.
Au moins 1Au plus 100Par défaut25
cursorstring: The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

Retourne

200TemplateVersionList

A page of versions, newest first. Every publish adds one, so follow nextCursor while hasMore is true to reach version 1. Keyset on the version number, so a version deleted between pages never breaks the walk.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.listVersions()templates.listAllVersions()templates.iterateVersions()
CLI: openemail templates list-versions
MCP: getTemplateVersionlistTemplateVersions

POST`/templates/{id}/versions`

Publish the draft

templates:writeModifie des données

A POST to the version COLLECTION, because that is what it creates: a frozen revision that live sends resolve against. Compiling happens here, so a template that does not render fails for the person publishing it rather than for the recipient of the next message.

Idempotent: publishing an already-published head returns it unchanged, so a deploy script that publishes unconditionally is safe to run twice.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Retourne

201object

Published. Live sends resolve to this from now on.

objectstring

L'un de"template_version"

idstring

tplv_ + 24 hex. Not the template id.

templateIdstring

versioninteger

Counts from 1, per template. This is what a send pins.

statestring

There is exactly one draft at a time and it is always the highest version. Editing writes into it in place; publishing freezes it and the next edit mints the one after.

L'un de"draft""published"

enginestring

L'un de"blocks""html"

subjectstring

slotsTemplateSlot[]

propsTemplateProp[]

documentobject

The body of a blocks template: the block tree plus the page settings wrapped around it. An html template has none of this and carries html instead.

Peut être null

bodyobject[]Obligatoire: The blocks, in order, 500 at most across the whole tree. Each is an object with a kind of Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock, CodeInline and the fields that kind takes; Section, Row, Column and Container nest through their own children, 8 deep at most.
Jusqu'à 500 éléments
previewstring: Preview text: the line most mail clients show after the subject in the list. Left out, the client picks the first words of the body for you, which is usually a greeting.
Jusqu'à 256 caractères
tailwindboolean: Read Tailwind class names on the blocks and inline them at publish. Off by default, because a template written without them gains nothing and pays the compile.
Par défautfalse
fontsTemplateFont[]: Web fonts to load, 8 at most. This is the only place fonts are declared; a font-family on a block refers to a family named here or to one already on the reader's machine.
Jusqu'à 8 éléments
styleobject: Page style for the whole message, as a CSS property bag in camelCase or kebab-case, for example { "backgroundColor": "#f5f5f5" }. Only the properties mail clients honour are accepted, and a rejected one is a 422 naming itself and listing what is allowed.
slotsTemplateSlot[]: The same list as the top-level slots on a create or a PATCH. Sending both is allowed and the top-level one wins.
propsTemplateProp[]: The same list as the top-level props, with the same precedence.

htmlstring

The markup exactly as it was submitted, for the html engine, and not what goes out: sanitising happens at publish, against the compiled copy. Returned where document is.

Peut être null

publishedAtstring

Peut être nullFormatdate-time

createdAtstring

Formatdate-time

templateTemplate

Erreurs

409: version_conflict: another writer published between your read and this call.
422: invalid_template. The draft does not compile; nothing was published.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.publish()
CLI: openemail templates publish
MCP: publishTemplate

GET`/templates/{id}/versions/{version}`

Retrieve one version

templates:readLit

One frozen revision with its body: document for the blocks engine, html for the html engine, plus the subject, slots and props that were declared at the time.

This is what the version LIST leaves out, and it is the only way to see what an old version holds without changing anything. Restoring used to be the only route to that, and a restore moves the head, so reading version 3 cost you your draft. It does not any more.

Use it to diff a regression against the revision that worked, to copy a block out of an older design, or to archive what a campaign actually said. POST /templates/{id}/versions/{version}/restore is still the call that brings it back.

Requires the templates:read scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.
versionintegerObligatoire: A version NUMBER as GET /templates/{id}/versions reports it, counting from 1, not a tplv_ id. Numbers are never reused, so a deleted one stays gone.
Au moins 1

Retourne

200TemplateVersion

That revision, body included.

Erreurs

404: template_version_not_found: no version with that number, or it was deleted.

Les erreurs que toute opération peut renvoyer400401403422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.getVersion()
CLI: openemail templates get-version
MCP: getTemplateVersionlistTemplateVersions

DELETE`/templates/{id}/versions/{version}`

Delete one version

templates:writeSupprime

Removes one revision and leaves the template alone. It is for tidying a long version list, not for changing what sends.

Three versions are refused, each as a 422 rather than a quiet success: the LIVE one, because sends resolve it; the HEAD, because that is the draft being edited, and restoring an older version first is how you move off it; and the only version a template has, because a template with no versions could not be read, so delete the template instead.

Mail already sent is untouched, since a send stores what it rendered. A send that pins a deleted version starts failing with template_version_not_found, and the number is never reused.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.
versionintegerObligatoire: A version NUMBER as GET /templates/{id}/versions reports it, counting from 1, not a tplv_ id. Numbers are never reused, so a deleted one stays gone.
Au moins 1

Retourne

200object

Deleted.

objectstring: L'un de"template_version"
templateIdstring
versioninteger
deletedboolean: L'un detrue

Erreurs

422: template_version_not_deletable: the version is the live one, the head being edited, or the only version there is.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.deleteVersion()
CLI: openemail templates delete-version
MCP: deleteTemplateVersion

POST`/templates/{id}/versions/{version}/restore`

Restore an older version

templates:writeModifie des données

Copies an older version's subject, body, slots and props forward into the head, which is how a design you regret is undone. Nothing is rolled back in place: the old version stays in the list and the restored copy becomes the current draft.

A published head mints version N+1; a draft head is overwritten, so restoring twice does not pile up versions. It does not publish, so live sends do not move until you do, and the restore is itself reversible until then.

Restoring the head is a 422 rather than a no-op, because it would silently do nothing. expectedVersion guards against a concurrent editor exactly as it does on a PATCH.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.
versionintegerObligatoire: A version NUMBER as GET /templates/{id}/versions reports it, counting from 1, not a tplv_ id. Numbers are never reused, so a deleted one stays gone.
Au moins 1

Corps de la requête

expectedVersioninteger: The head version you read before restoring. A mismatch is a 409 version_conflict and nothing is written.
Plus de 0

Retourne

200object

Restored into the head. Nothing live has moved.

objectstring: L'un de"template"
idstring: The durable handle, tpl_ + 24 hex.
namestring
slugstring: Derived from the name when the template is created and never re-derived on rename, so retitling "Order shipped" to "Dispatch confirmation" cannot 404 an integration that has been sending against it. This is the handle to pin in code; every path taking an {id} takes it too.
descriptionstring: Peut être null
statusstring: Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.
L'un de"draft""active""archived"
publishedVersioninteger: The revision a live send resolves to. Null means nothing has been published and the template cannot be sent. A send is refused with template_not_published rather than quietly going out as whatever the draft currently says.
Peut être null
latestVersioninteger: The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.
subjectstring: The published version's, and absent when nothing is published. Carries {{placeholders}} filled from the same values the body uses, so it is versioned with the body rather than stored on the template.
enginestring: blocks is a validated tree over the exports of @react-email/components, checked at its input. html is markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reason subject is: it is a property of a version, not of the template.
L'un de"blocks""html"
slotsTemplateSlot[]: The published version's declarations. Absent when nothing is published.
propsTemplateProp[]: What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.
createdAtstring: Formatdate-time
updatedAtstring: Formatdate-time
latestTemplateVersion
restoredFrominteger: The version the body was copied from.

Erreurs

409: version_conflict: another writer moved the head since your read.
422: invalid_template: that version is the head, so there is nothing to restore.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.restoreVersion()
CLI: openemail templates restore-version

POST`/templates/{id}/preview`

Render without sending

templates:readLit

The endpoint to point CI at. It resolves a version, substitutes the values and hands back exactly what a send would put in the message, so a template change is caught by a test rather than by a customer.

Lenient where a send is strict: a missing required prop comes back in warnings rather than refusing, because a template being previewed is usually a template being written. A send gets no such leniency. version may name a DRAFT here, which is the other thing a send cannot do.

Always application/json, never text/html. The HTML is a string field. A raw document would be JSON.parsed by every SDK transport and resolve to nothing at all.

Requires the templates:read scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Corps de la requête

versioninteger: Version to render, drafts included. Defaults to the published version.
Plus de 0
propsRecord<string, any>: Values for declared props, keyed by prop key. Strings, numbers and booleans only.
slotsRecord<string, any>: Overrides for slot defaults, keyed by slot key.

Retourne

200TemplatePreview

The rendered subject, HTML and text.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.preview()
CLI: openemail templates preview
MCP: previewTemplate

GET`/templates/{id}/analytics`

How a template has performed

templates:readLit

The report the console shows on a template: how much it sent, how much of that was tracked, how much was opened and clicked, and the same figures by day, by source and by version.

Rates are computed over what was TRACKED rather than over everything sent, because a message sent with tracking off can never report an open and counting it would quietly lower every rate. Both denominators are in the response so nothing has to be taken on trust.

lifetime ignores the window: every live send ever, the test-key sends counted separately, and the first and last time it sent. A template that has never sent answers with zeroes rather than a 404; the 404 is for a template that does not exist.

Requires the templates:read scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Paramètres de requête

daysinteger: How far back to look. Defaults to 30. The window starts at the beginning of that day in the offset you asked for and ends now, so the newest bucket is partial.
Au moins 1Au plus 365
minutesinteger: The window in minutes, which wins over days. A whole number of days cannot say "the last hour", which is the report worth having while a send is going out.
Au moins 1Au plus 1576800
grainstring: How wide one byDay bucket is, and the shape of its key: YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM.
L'un de"minute""hour""day"
offsetMinutesinteger: The reader's UTC offset in minutes, so a day is their day rather than UTC's.
Au moins -840Au plus 840

Retourne

200TemplateAnalytics

The engagement report for this template.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.getAnalytics()
CLI: openemail templates get-analytics
MCP: getTemplateAnalytics

GET`/templates/{id}/sends`

The messages a template sent

templates:readLit

One row per message this template rendered, newest first, with the subject as it went out, who it went to, and whether it was opened or clicked. It is the list behind the analytics numbers, and the way to answer "did this person get it".

total counts the rows matching the filters rather than the page, which is what a table needs. Page numbers are not stable while mail is going out, since a new send pushes rows down: narrow the window rather than paging deep.

opens and clicks say what the message ASKED for; openCount and clickCount say what happened. Only live sends are listed.

Requires the templates:read scope.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

Paramètres de requête

daysinteger: How far back to look. Defaults to 30.
Au moins 1Au plus 365
minutesinteger: The window in minutes, which wins over days.
Au moins 1Au plus 1576800
grainstring: Only floors the start of the window, so this list can cover the same window as the analytics read at that grain. It shapes nothing in the response.
L'un de"minute""hour""day"
offsetMinutesinteger: The reader's UTC offset in minutes.
Au moins -840Au plus 840
pageinteger: Which page, from 1. Defaults to 1. Page numbers, not a cursor, because the console shows a table with a total.
Au moins 1
pageSizeinteger: Rows per page, 1 to 100. Defaults to 25.
Au moins 1Au plus 100
searchstring: Matches the subject that went out and the recipient addresses.
Jusqu'à 200 caractères
sourcestring: Only sends from one surface, such as the API or the console.
Jusqu'à 64 caractères
versioninteger: Only sends that rendered this version number.
Plus de 0
openedstring: True for sends with at least one counted open, false for none of them.
L'un de"true""false"
clickedstring: True for sends with at least one counted click, false for none of them.
L'un de"true""false"
trackedstring: True for sends that carried tracking at all. The false side is the mail that could never have reported anything.
L'un de"true""false"

Retourne

200TemplateSendList

One row per message, newest first, with the total matching the filters.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.listSends()
CLI: openemail templates list-sends
MCP: listTemplateSends

POST`/templates/{id}/send`

Send with a template

templates:writeemails:sendEnvoie des e-mails

Prend en charge Idempotency-Key

Resolves the published version (or the one version pins), substitutes props and slots, and sends. subject overrides the version's own for this message only.

Props are validated STRICTLY, which is the opposite of the preview: an unknown key is refused rather than ignored, and a declared required key that is missing is refused rather than rendered as a blank. Mail cannot be recalled, and a hole where the order number should be is not something a recipient can report back to you.

Also requires emails:send, and neither scope is redundant: reaching a stored body is templates:write, mail leaving the workspace is emails:send. A key that may send its own bodies still cannot send somebody else's template.

POST /emails takes a template field that does the same thing, for a caller already composing a message.

Requires the templates:write and emails:send scopes.

Paramètres de chemin

idstringObligatoire: A tpl_ id or the template's slug. Both are accepted on every templates path: an integration pins a slug and a UI passes an id, and making either one say which it holds buys nothing. Ids carry the prefix, so the two vocabularies cannot collide.

En-têtes

Idempotency-Keystring: Makes a retry safe. Reusing one with a different body is a 422.
Jusqu'à 255 caractèresMotif^[A-Za-z0-9_.:-]+$

Corps de la requête

fromstring | objectObligatoire

Sender as address, Name <address> or { email, name }. The key must be allowed to send as it, otherwise 403 from_address_forbidden.

emailstringObligatoire: Jusqu'à 320 caractères
namestring: Jusqu'à 128 caractères

to(string | object)[]Obligatoire

1 to 50 recipients. The SDK wraps a single value in an array.

De 1 à 50 éléments

emailstringObligatoire: Jusqu'à 320 caractères
namestring: Jusqu'à 128 caractères

cc(string | object)[]

Up to 50 copied recipients.

Jusqu'à 50 élémentsPar défaut[]

emailstringObligatoire: Jusqu'à 320 caractères
namestring: Jusqu'à 128 caractères

bcc(string | object)[]

Up to 50 blind copied recipients.

Jusqu'à 50 élémentsPar défaut[]

emailstringObligatoire: Jusqu'à 320 caractères
namestring: Jusqu'à 128 caractères

replyTostring | object

Sets the Reply-To header.

emailstringObligatoire: Jusqu'à 320 caractères
namestring: Jusqu'à 128 caractères

versioninteger

Published version to send. Defaults to the currently published one.

Plus de 0

propsRecord<string, any>

Values for the declared props: strings, numbers or booleans, keyed by prop key.

slotsRecord<string, any>

Overrides for slot defaults, keyed by slot key.

subjectstring

Replaces the version's subject for this message, sent verbatim, at most 998 characters.

Jusqu'à 998 caractères

scheduledAtstring

When to send: a Date, an ISO 8601 instant or a duration like PT2H. Must be in the future and at most 365 days out.

De 3 à 64 caractères

cancellableForSecondsinteger

Holds the message 0 to 900 seconds so it can still be cancelled. Defaults to 0 and is refused alongside scheduledAt.

Au moins 0Au plus 900Par défaut0

trackingobject

Per message opens and clicks switches for open and click tracking.

opensboolean
clicksboolean

translateobject

Translates the rendered message into to before sending, with optional from, includeOriginal (default true) and subject (default true).

tostringObligatoire: De 2 à 60 caractères
fromstring: De 2 à 60 caractères
includeOriginalboolean: Par défauttrue
subjectboolean: Par défauttrue

tagsRecord<string, string>

Your own labels for the send, keys up to 64 and values up to 256 characters.

Par défaut{}

Retourne

200object

An Idempotency-Key replayed an earlier send. This is that message, not a new one.

objectstring

L'un de"email"

idstring

The durable handle, msg_ + 24 hex.

statusstring

L'un de"queued""scheduled""sending""sent""partial""cancelled""failed"

modestring

L'un de"live""test"

fromstring

subjectstring

Peut être null

messageIdstring

RFC 5322 Message-ID. Null until the MIME exists. Do NOT correlate on it: the header is rewritten on the way out, so the value here appears in no bounce or delivery report and a match on it never fires. A delivery event names the send by its id, as emailId.

Peut être null

threadIdstring

Peut être null

transportstring

How the bytes left, once they have. Null until dispatch. test is what a message sent with an oe_test_ key records: it was accepted and every recipient marked delivered, but nothing was carried. dev is not a way of sending either: it is what a message records where nothing is configured to carry mail, having been built and sent nowhere.

Peut être nullL'un de"ses""test""dev"

attemptsinteger

lastErrorstring

Peut être null

scheduledAtstring

Peut être nullFormatdate-time

cancellableUntilstring

Peut être nullFormatdate-time

sentAtstring

Peut être nullFormatdate-time

tagsRecord<string, string>

broadcastIdstring

The brd_ broadcast this message is one copy of, or null for a message sent on its own. GET /emails?broadcastId= lists every copy of one broadcast.

Peut être null

sourcestring

L'un de"api""oauth""composer""mcp""ai""form"

createdAtstring

Formatdate-time

recipientsobject[]

Returned on retrieval only.

emailstring
namestring: Peut être null
kindstring: L'un de"to""cc""bcc"
statusstring: uncertain is real and is shown as itself: a transport that failed part-way cannot say which recipients it reached, and calling those delivered or failed would both be guesses. suppressed is decided before dispatch rather than reported afterwards: the address bounced or complained in this workspace before, so this copy was never offered to the transport. A message whose recipients are all suppressed fails outright.
L'un de"pending""delivered""failed""bounced""complained""suppressed""uncertain"
errorstring: Peut être null
deliveredAtstring: Peut être nullFormatdate-time

translationobject

Present only when the message was translated, and only on responses that carry the stored request, which are the send itself and a retrieval. A list row does not fetch it, so its absence there says nothing either way.

languagestring: The resolved target code: de, pt-BR.
languageNamestring: Its English name.
detectedSourceLanguagestring: Stated or detected. Null when detection abstained.
Peut être null
subjectboolean: Whether the subject was translated too.
includeOriginalboolean: Whether the sender's own words went below the translation.

trackingTracking

templateobject

idstring
versioninteger: Peut être null

202object

Accepted. template.version is the version that went out, whether you pinned it or the published one was resolved.

objectstring

L'un de"email"

idstring

The durable handle, msg_ + 24 hex.

statusstring

L'un de"queued""scheduled""sending""sent""partial""cancelled""failed"

modestring

L'un de"live""test"

fromstring

subjectstring

Peut être null

messageIdstring

Peut être null

threadIdstring

Peut être null

transportstring

Peut être nullL'un de"ses""test""dev"

attemptsinteger

lastErrorstring

Peut être null

scheduledAtstring

Peut être nullFormatdate-time

cancellableUntilstring

Peut être nullFormatdate-time

sentAtstring

Peut être nullFormatdate-time

tagsRecord<string, string>

broadcastIdstring

The brd_ broadcast this message is one copy of, or null for a message sent on its own. GET /emails?broadcastId= lists every copy of one broadcast.

Peut être null

sourcestring

L'un de"api""oauth""composer""mcp""ai""form"

createdAtstring

Formatdate-time

recipientsobject[]

Returned on retrieval only.

emailstring
namestring: Peut être null
kindstring: L'un de"to""cc""bcc"
statusstring: uncertain is real and is shown as itself: a transport that failed part-way cannot say which recipients it reached, and calling those delivered or failed would both be guesses. suppressed is decided before dispatch rather than reported afterwards: the address bounced or complained in this workspace before, so this copy was never offered to the transport. A message whose recipients are all suppressed fails outright.
L'un de"pending""delivered""failed""bounced""complained""suppressed""uncertain"
errorstring: Peut être null
deliveredAtstring: Peut être nullFormatdate-time

translationobject

languagestring: The resolved target code: de, pt-BR.
languageNamestring: Its English name.
detectedSourceLanguagestring: Stated or detected. Null when detection abstained.
Peut être null
subjectboolean: Whether the subject was translated too.
includeOriginalboolean: Whether the sender's own words went below the translation.

trackingTracking

templateobject

idstring
versioninteger: Peut être null

Erreurs

409: domain_not_sendable: the from domain cannot sign mail yet, so nothing was accepted.
422: The props did not satisfy the version: missing_template_prop, unknown_template_prop, unknown_template_slot or invalid_template_prop, each with param naming the key. Also template_not_published when nothing has been published yet.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.send()
CLI: openemail templates send

GET`/templates/images`

List template images

templates:readLit

The images uploaded for templates, newest first: the same library the template editor offers. Template images belong to the workspace: every template in it can use them, and they stay at their address after the template that first used them is deleted.

Requires the templates:read scope.

Paramètres de requête

limitinteger: Rows per page, 1 to 120.
Au moins 1Au plus 120Par défaut24
cursorstring: The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

Retourne

200TemplateImageList

A page of images.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

SDK: templates.listImages()templates.listAllImages()templates.iterateImages()
CLI: openemail templates list-images
MCP: listTemplateImages

POST`/templates/images`

Upload a template image

templates:writeModifie des données

Send the image bytes as the request body with their type as Content-Type: image/png, image/jpeg, image/webp, image/gif, image/svg+xml, up to 5 MB. It is fitted into 1200 by 1800 pixels and stored in a form every mail client shows, and url is the public address to put in a template. Template images belong to the workspace: every template in it can use them, and they stay at their address after the template that first used them is deleted.

Requires the templates:write scope.

Corps de la requête

Type de contenuimage/png, image/jpeg, image/webp, image/gif, image/svg+xml

binary

Retourne

201UploadedTemplateImage

Stored. Use url in a template.

Erreurs

422: invalid_image: the body is not an image of an accepted type, is over 5 MB, or cannot be read.
502: image_not_stored: the image was read but could not be stored. Try again.
503: image_busy: the image service is busy. Try again.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.uploadImage()
CLI: openemail templates upload-image
MCP: uploadTemplateImage

POST`/templates/design`

Design a template from a brief

templates:writeModifie des données

A designer builds a new block template from a written brief, the way the assistant in the app does, and saves it as a draft unless publish is true. starter builds on a starter design, and imageFileIds names up to ten uploaded or received images to place in it. It spends one AI action and can take up to a minute.

Requires the templates:write scope.

Corps de la requête

namestringObligatoire: A short name for the template. When the name is taken, a free one is chosen and returned.
De 1 à 100 caractères
briefstringObligatoire: Everything the design must hold and look like, up to 8,000 characters.
De 1 à 8000 caractères
descriptionstring: One line about what it is for.
Jusqu'à 500 caractères
starterstring: The slug of a starter design to build on, from listStarters.
De 1 à 64 caractères
imageFileIdsstring[]: Up to ten file ids of images to place in the design.
Jusqu'à 10 éléments
publishboolean: Publish it at once so it can be sent. Defaults to false.

Retourne

201object

The new template.

objectstring

L'un de"template"

idstring

The durable handle, tpl_ + 24 hex.

namestring

slugstring

Derived from the name when the template is created and never re-derived on rename, so retitling "Order shipped" to "Dispatch confirmation" cannot 404 an integration that has been sending against it. This is the handle to pin in code; every path taking an {id} takes it too.

descriptionstring

Peut être null

statusstring

Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.

L'un de"draft""active""archived"

publishedVersioninteger

The revision a live send resolves to. Null means nothing has been published and the template cannot be sent. A send is refused with template_not_published rather than quietly going out as whatever the draft currently says.

Peut être null

latestVersioninteger

The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.

subjectstring

The published version's, and absent when nothing is published. Carries {{placeholders}} filled from the same values the body uses, so it is versioned with the body rather than stored on the template.

enginestring

blocks is a validated tree over the exports of @react-email/components, checked at its input. html is markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reason subject is: it is a property of a version, not of the template.

L'un de"blocks""html"

slotsTemplateSlot[]

The published version's declarations. Absent when nothing is published.

propsTemplateProp[]

What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.

createdAtstring

Formatdate-time

updatedAtstring

Formatdate-time

designobject

subjectstring: The subject the designer wrote or kept.
notesstring[]: What was adjusted while saving the design.
imageProblemsstring[]: Each image in imageFileIds that could not be used, and why.

Erreurs

409: ai_not_configured: this server has no model to design with.
422: invalid_template when the design could not be made valid, or the template is raw HTML. invalid_parameter for a body that does not validate.
429: ai_quota_exceeded: the workspace has used its AI actions for today.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.design()
CLI: openemail templates design

POST`/templates/{id}/redesign`

Change a template’s design from instructions

templates:writeModifie des données

A designer applies written instructions to the block template and leaves everything else alone: restyle it, rewrite or translate its copy, add, move or remove sections. The change lands in the draft, and live sends keep the published version until it is published. It spends one AI action.

Requires the templates:write scope.

Paramètres de chemin

idstringObligatoire

Corps de la requête

instructionsstringObligatoire: What to change, with every detail: the words, colours and which section. Up to 8,000 characters.
De 1 à 8000 caractères
imageFileIdsstring[]: Up to ten file ids of images to use.
Jusqu'à 10 éléments
expectedVersioninteger: The version you based the change on. A newer one is refused with 409 version_conflict.
Plus de 0

Retourne

200object

The template, with design.changes and the draft version that holds them.

objectstring

L'un de"template"

idstring

The durable handle, tpl_ + 24 hex.

namestring

slugstring

descriptionstring

Peut être null

statusstring

Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.

L'un de"draft""active""archived"

publishedVersioninteger

Peut être null

latestVersioninteger

The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.

subjectstring

enginestring

L'un de"blocks""html"

slotsTemplateSlot[]

The published version's declarations. Absent when nothing is published.

propsTemplateProp[]

What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.

createdAtstring

Formatdate-time

updatedAtstring

Formatdate-time

designobject

subjectstring: The subject the designer wrote or kept.
notesstring[]: What was adjusted while saving the design.
imageProblemsstring[]: Each image in imageFileIds that could not be used, and why.

Erreurs

409: ai_not_configured: this server has no model to design with.
422: invalid_template when the design could not be made valid, or the template is raw HTML. invalid_parameter for a body that does not validate.
429: ai_quota_exceeded: the workspace has used its AI actions for today.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

SDK: templates.redesign()
CLI: openemail templates redesign

Objets

`Template`object

objectstring: L'un de"template"
idstring: The durable handle, tpl_ + 24 hex.
namestring
slugstring: Derived from the name when the template is created and never re-derived on rename, so retitling "Order shipped" to "Dispatch confirmation" cannot 404 an integration that has been sending against it. This is the handle to pin in code; every path taking an {id} takes it too.
descriptionstring: Peut être null
statusstring: Whether anybody is meant to reach for it, which is not the same question as whether it has a published version. archived is the reversible form of deleting one.
L'un de"draft""active""archived"
publishedVersioninteger: The revision a live send resolves to. Null means nothing has been published and the template cannot be sent. A send is refused with template_not_published rather than quietly going out as whatever the draft currently says.
Peut être null
latestVersioninteger: The head. Equal to publishedVersion until somebody edits the body, which mints the next draft and leaves live sends on the published one.
subjectstring: The published version's, and absent when nothing is published. Carries {{placeholders}} filled from the same values the body uses, so it is versioned with the body rather than stored on the template.
enginestring: blocks is a validated tree over the exports of @react-email/components, checked at its input. html is markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reason subject is: it is a property of a version, not of the template.
L'un de"blocks""html"
slotsTemplateSlot[]: The published version's declarations. Absent when nothing is published.
propsTemplateProp[]: What a send must supply. Read the required ones off this rather than off a preview: a preview tolerates them being missing and a send does not.
createdAtstring: Formatdate-time
updatedAtstring: Formatdate-time

`TemplateAnalytics`object

objectstring

L'un de"template_analytics"

templateIdstring

Always the tpl_ id, even when a slug was asked for.

sendsinteger

Messages this template rendered in the window, live keys only. A test-key send is counted in lifetime.testSends and nowhere else.

matchedinteger

How many of those renders were paired with a tracked message. The gap between this and sends is mail that carried no tracking at all, not data that went missing.

trackedForOpensinteger

The denominator behind openRate. Counting untracked sends in it would quietly lower every rate.

trackedForClicksinteger

The denominator behind clickRate.

openedinteger

Sends with at least one counted open.

clickedinteger

Sends with at least one counted click.

openRatenumber

A percentage to one decimal place, over trackedForOpens. Zero rather than null when nothing was tracked.

clickRatenumber

The same, over trackedForClicks.

totalOpensinteger

Every counted open, repeats included.

totalClicksinteger

bySourceobject[]

Which surface sent it: the API, the console, a rule, the assistant.

sourcestring
sendsinteger

byDayobject[]

One entry per bucket at the grain you asked for. The key is YYYY-MM-DD for a day, YYYY-MM-DDTHH for an hour, YYYY-MM-DDTHH:MM for a minute.

daystring
sentinteger
sendsinteger
trackedForOpensinteger
trackedForClicksinteger
openedinteger
clickedinteger

byVersionobject[]

The same figures per version, newest first, which is how a redesign is compared with what it replaced.

versioninteger
sendsinteger
trackedForOpensinteger
trackedForClicksinteger
openedinteger
clickedinteger

recentobject[]

A preview: the twelve newest sends in the window, newest first, with their own counts. Every send in the window, a page at a time, is GET /templates/{id}/sends.

idstring
versioninteger
sourcestring
createdAtstring: Formatdate-time
matchedboolean
opensboolean: Whether the message asked to be tracked for opens.
clicksboolean
openCountinteger
clickCountinteger

lifetimeobject

Ignores the window entirely: every send this template has ever made.

sendsinteger
testSendsinteger: Sent with a test key, so nothing was carried.
firstAtstring: Peut être nullFormatdate-time
lastAtstring: Peut être nullFormatdate-time

`TemplateFont`object

One web font the template loads. A mail client that blocks the download falls back to fallbackFontFamily, so name a real stack there rather than a second web font.

fontFamilystringObligatoire

The family name as the blocks reference it, for example Playfair Display. Letters, digits, spaces, dots, hyphens, commas and quotes.

Jusqu'à 128 caractères

fallbackFontFamilystringObligatoire

What renders when the web font does not, for example Georgia, serif. Required: a font with no fallback is a message that renders in whatever the client picked.

Jusqu'à 128 caractères

webFontobject

Where the file lives. Leave it out for a font already installed on the reader's machine, such as Georgia or Arial, which costs no download and is the safer choice in mail.

urlstringObligatoire: The url the named family is served from, exactly as GET /templates/fonts reports it. Any other url is a 422: a font file is fetched by the reader when the mail is opened, so an arbitrary host would be told who opened what and when, whatever the workspace has tracking set to.
L'un de"https://fonts.gstatic.com/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K6z9mXg.woff2""https://fonts.gstatic.com/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2""https://fonts.gstatic.com/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3yUBHMdazQ.woff2""https://fonts.gstatic.com/s/opensans/v44/memvYaGs126MiZpBA-UvWbX2vVnXBbObj2OVTS-mu0SC55I.woff2""https://fonts.gstatic.com/s/lato/v25/S6uyw4BMUTPHjx4wXiWtFCc.woff2""https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm459WlhyyTh89Y.woff2""https://fonts.gstatic.com/s/poppins/v24/pxiEyp8kv8JHgFVrJJfecnFHGPc.woff2""https://fonts.gstatic.com/s/nunito/v32/XRXV3I6Li01BKofINeaBTMnFcQ.woff2""https://fonts.gstatic.com/s/worksans/v24/QGYsz_wNahGAdqQ43Rh_fKDptfpA4Q.woff2""https://fonts.gstatic.com/s/sourcesans3/v19/nwpStKy2OAdR1K-IwhWudF-R3w8aZejf5Hc.woff2""https://fonts.gstatic.com/s/ibmplexsans/v23/zYXzKVElMYYaJe8bpLHnCwDKr932-G7dytD-Dmu1syxeKYbSB4Zh.woff2""https://fonts.gstatic.com/s/merriweather/v33/u-4e0qyriQwlOrhSvowK_l5UcA6zuSYEqOzpPe3HOZJ5eX1WtLaQwmYiSeqqJ-mXq1Gi.woff2""https://fonts.gstatic.com/s/playfairdisplay/v40/nuFiD-vYSZviVYUb_rj3ij__anPXDTzYgEM86xQ.woff2""https://fonts.gstatic.com/s/instrumentserif/v5/jizBRFtNs2ka5fXjeivQ4LroWlx-6zUTjnTLgNs.woff2""https://fonts.gstatic.com/s/jetbrainsmono/v24/tDbV2o-flEEny0FZhsfKu5WU4xD7OwGtT0rU.woff2""https://fonts.gstatic.com/s/dmmono/v16/aFTU7PB1QTsUX8KYthqQBK6PYK0.woff2""https://fonts.gstatic.com/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmhHkjko.woff2"
formatstringObligatoire: L'un de"woff2""woff""truetype""opentype""embedded-opentype""svg"

fontWeightstring | integer

A number, a keyword (normal, bold, bolder, lighter), or two numbers for a variable range, as in 100 900.

fontStylestring

L'un de"normal""italic""oblique"

`TemplateFontCatalogueEntry`object

One font this API will serve inside a template. The catalogue is the whole of what fonts[].webFont.url accepts.

objectstring: L'un de"template_font"
familystring: The family name to put in fonts[].fontFamily and in a block's font-family.
fallbackstring: The email safe family to put in fallbackFontFamily. It is what a client that refuses the download renders.
stackstring: The whole CSS font stack, family first and fallbacks behind it, ready to drop into a font-family style.
weightstring: What the file carries: one weight, as in 400, or two numbers for a variable range, as in 100 900. Asking for a weight outside it makes the client synthesise one.
formatstring: L'un de"woff2"
urlstring: The url to put in fonts[].webFont.url. No other url is accepted for this family.

`TemplateFontList`object

objectstring: L'un de"list"
dataTemplateFontCatalogueEntry[]

`TemplateImage`object

objectstringObligatoire: L'un de"template_image"
idstringObligatoire
urlstringObligatoire: The public address of the image.
Formaturi
sizeintegerObligatoire: Bytes, as stored.

`TemplateImageList`object

objectstring: L'un de"list"
dataTemplateImage[]
hasMoreboolean: True when another page follows. Pass nextCursor back as cursor to read it.
nextCursorstring: An opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Peut être null

`TemplateList`object

objectstring: L'un de"list"
dataTemplate[]
hasMoreboolean
nextCursorstring: Peut être null

`TemplatePreview`object

objectstring

L'un de"template_preview"

templateIdstring

versioninteger

Which revision was rendered, resolved rather than echoed, so a preview that named no version records what "published" meant at that moment.

subjectstring

With its placeholders already filled.

htmlstring

Byte for byte what a send with these values would put in the message.

textstring

The text/plain alternative, from the same render.

warningsobject[]

What is still empty. A preview reports these and renders anyway; a send refuses on the same condition. Empty here is the check worth putting in CI.

codestring: unfilled_placeholder today. Treat an unrecognised code as a warning.
keystring

`TemplateProp`object

keystring: A letter followed by letters, digits or underscores. This is what {{key}} in the subject or the body refers to, and what a send names in props or slots.
labelstring: For whoever fills it in. Never rendered into the message.
kindstring: How a supplied value is escaped when it lands in the body. text becomes a React child, so React escapes it; url and image are parsed and scheme-checked before they reach an href or a src. The kind is declared rather than sniffed from the value, because a string that happens to start with https: is not evidence that the author meant it to be followed.
L'un de"text""url""image"
requiredboolean: A required prop missing at send is a 422 and no mail leaves. That refusal is the most valuable rule in the feature: the alternative is a message going out with a blank where the order number should be, which nothing reports, nobody notices, and no one can recall.
defaultstring: Used when the caller names nothing. Null means there is no fallback: either the prop is required and its absence is refused, or it renders empty.
Peut être null

`TemplateRender`object

objectstring

L'un de"template_render"

subjectstring

With its placeholders filled, or marked when asked.

htmlstring

What a send of this body would put in the message. Nothing was stored to produce it, so this is the call for checking a design in CI before it is a template.

textstring

The text/plain alternative, from the same render.

warningsobject[]

The declared keys still empty. This endpoint reports them and renders anyway, exactly as a preview does, and a send refuses on the same condition.

codestring: unfilled_placeholder today. Treat an unrecognised code as a warning.
keystring

`TemplateSend`object

objectstring: L'un de"template_send"
idstring: The render id, tplr_ + hex. Not the message id.
versioninteger: The version this message rendered.
sourcestring
subjectstring: As it went out, with the placeholders already filled.
createdAtstring: Formatdate-time
recipientsstring[]
matchedboolean: Whether this render was paired with a tracked message. False means nothing can ever be reported about it, which is not the same as nobody opening it.
opensboolean: Whether the message asked to be tracked for opens.
clicksboolean
openCountinteger: What actually happened, as opposed to what was asked for.
clickCountinteger

`TemplateSendList`object

objectstring: L'un de"list"
dataTemplateSend[]
totalinteger: Rows matching the filters, not rows on this page.
pageinteger
pageSizeinteger

`TemplateSlot`object

keystring: A letter followed by letters, digits or underscores. This is what {{key}} in the subject or the body refers to, and what a send names in props or slots.
labelstring: For whoever fills it in. Never rendered into the message.
kindstring: How a supplied value is escaped when it lands in the body. text becomes a React child, so React escapes it; url and image are parsed and scheme-checked before they reach an href or a src. The kind is declared rather than sniffed from the value, because a string that happens to start with https: is not evidence that the author meant it to be followed.
L'un de"text""url""image"
defaultstring: What renders when nobody overrides it. Never null. A slot always has something to fall back to, which is the difference between it and a prop.

`TemplateStarter`object

objectstring: L'un de"template_starter"
slugstring: The handle to send as starter on a create or a content replacement. It names a design shipped with the product, never workspace data, so it is stable across workspaces and keys.
namestring
descriptionstring
categorystring: How the console groups the picker. Nothing behaves differently per category.
L'un de"account""commerce""notify""marketing"
subjectstring: The subject the starter comes with, placeholders and all.
slotsTemplateSlot[]: What the starter declares for an author to fill.
propsTemplateProp[]: What the starter declares for a send to fill. A template made from it starts with exactly these, and they are yours to change afterwards.

`TemplateStarterDetail`object

objectstring

L'un de"template_starter"

slugstring

The handle to send as starter on a create or a content replacement. It names a design shipped with the product, never workspace data, so it is stable across workspaces and keys.

namestring

descriptionstring

categorystring

How the console groups the picker. Nothing behaves differently per category.

L'un de"account""commerce""notify""marketing"

subjectstring

The subject the starter comes with, placeholders and all.

slotsTemplateSlot[]

What the starter declares for an author to fill.

propsTemplateProp[]

What the starter declares for a send to fill. A template made from it starts with exactly these, and they are yours to change afterwards.

documentobject

The body of a blocks template: the block tree plus the page settings wrapped around it. An html template has none of this and carries html instead.

bodyobject[]Obligatoire: The blocks, in order, 500 at most across the whole tree. Each is an object with a kind of Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock, CodeInline and the fields that kind takes; Section, Row, Column and Container nest through their own children, 8 deep at most.
Jusqu'à 500 éléments
previewstring: Preview text: the line most mail clients show after the subject in the list. Left out, the client picks the first words of the body for you, which is usually a greeting.
Jusqu'à 256 caractères
tailwindboolean: Read Tailwind class names on the blocks and inline them at publish. Off by default, because a template written without them gains nothing and pays the compile.
Par défautfalse
fontsTemplateFont[]: Web fonts to load, 8 at most. This is the only place fonts are declared; a font-family on a block refers to a family named here or to one already on the reader's machine.
Jusqu'à 8 éléments
styleobject: Page style for the whole message, as a CSS property bag in camelCase or kebab-case, for example { "backgroundColor": "#f5f5f5" }. Only the properties mail clients honour are accepted, and a rejected one is a 422 naming itself and listing what is allowed.
slotsTemplateSlot[]: The same list as the top-level slots on a create or a PATCH. Sending both is allowed and the top-level one wins.
propsTemplateProp[]: The same list as the top-level props, with the same precedence.

previewstring

The starter rendered to HTML with every undefaulted prop left visible as {{key}}, which is what the console shows in its picker. Rendered once per process, so asking repeatedly costs nothing.

`TemplateStarterList`object

objectstring: L'un de"list"
dataTemplateStarter[]

`TemplateVersion`object

objectstring

L'un de"template_version"

idstring

tplv_ + 24 hex. Not the template id.

templateIdstring

versioninteger

Counts from 1, per template. This is what a send pins.

statestring

There is exactly one draft at a time and it is always the highest version. Editing writes into it in place; publishing freezes it and the next edit mints the one after.

L'un de"draft""published"

enginestring

L'un de"blocks""html"

subjectstring

slotsTemplateSlot[]

propsTemplateProp[]

documentobject

The body of a blocks template: the block tree plus the page settings wrapped around it. An html template has none of this and carries html instead.

Peut être null

bodyobject[]Obligatoire: The blocks, in order, 500 at most across the whole tree. Each is an object with a kind of Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock, CodeInline and the fields that kind takes; Section, Row, Column and Container nest through their own children, 8 deep at most.
Jusqu'à 500 éléments
previewstring: Preview text: the line most mail clients show after the subject in the list. Left out, the client picks the first words of the body for you, which is usually a greeting.
Jusqu'à 256 caractères
tailwindboolean: Read Tailwind class names on the blocks and inline them at publish. Off by default, because a template written without them gains nothing and pays the compile.
Par défautfalse
fontsTemplateFont[]: Web fonts to load, 8 at most. This is the only place fonts are declared; a font-family on a block refers to a family named here or to one already on the reader's machine.
Jusqu'à 8 éléments
styleobject: Page style for the whole message, as a CSS property bag in camelCase or kebab-case, for example { "backgroundColor": "#f5f5f5" }. Only the properties mail clients honour are accepted, and a rejected one is a 422 naming itself and listing what is allowed.
slotsTemplateSlot[]: The same list as the top-level slots on a create or a PATCH. Sending both is allowed and the top-level one wins.
propsTemplateProp[]: The same list as the top-level props, with the same precedence.

htmlstring

The markup exactly as it was submitted, for the html engine, and not what goes out: sanitising happens at publish, against the compiled copy. Returned where document is.

Peut être null

publishedAtstring

Peut être nullFormatdate-time

createdAtstring

Formatdate-time

`TemplateVersionList`object

objectstring: L'un de"list"
dataTemplateVersion[]
hasMoreboolean: True when another page follows. Pass nextCursor back as cursor to read it.
nextCursorstring: An opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Peut être null

`Tracking`object

Every /tracking endpoint returns this whole, its list included. It arrives trimmed in exactly one place, under tracking on a GET /emails row, where it is the counts half only: opens, clicks, opened, clicked, openCount, clickCount and firstOpenAt. A page of fifty sends each carrying its recipients and its links is a report nobody asked to have expanded. The trimmed form has no id on it either, so /emails/{id}/tracking rather than /tracking/{id} is the way back to the rest of it.

objectstring

Present when the report is the whole response body. Absent under an email's tracking field, which is part of that email rather than a resource in its own right.

L'un de"tracking"

idstring

The tracking record, tmsg_ + 24 hex. Not the message id and not the send id.

sendIdstring

The msg_ this went out as, when the send service handled it. Null for mail the mailbox agent sent on its own behalf, which is most composer, MCP and assistant traffic. Those messages do get a send record, but nothing links this tracking row to it. Tracking covers the mailbox rather than only the traffic that came through this API.

Peut être null

threadIdstring

Peut être null

messageIdstring

RFC 5322 Message-ID. Not a correlation key. The header is rewritten on the way out. Correlate on id.

Peut être null

subjectstring

Peut être null

fromstring

sourcestring

L'un de"api""oauth""composer""mcp""ai""form"

sentAtstring

Peut être nullFormatdate-time

opensboolean

What was APPLIED to this message, resolved when it was sent from the setting of the address it was sent from (its own, else its domain catch-all's, else off, while a broadcast copy is on unless the broadcast or its address turned it off) and any per-send override, not what is switched on now. Turning tracking on today does not make yesterday's mail start reporting, and a report that implied otherwise would read as "nobody opened it".

clicksboolean

As opens, for link rewriting. The two are independent switches.

openedboolean

clickedboolean

attributableboolean

Whether every reading on this message can be pinned to a named recipient. False as soon as an unattributed copy has activity of its own, which is what happens whenever one body went to the whole list rather than a separate one per person. This is the flag that decides whether "Bob has not opened it" is a sentence a client is entitled to write, or whether all it may say is that somebody did. recipients carries the same fact one row at a time, and one row at a time is where it gets missed.

openCountinteger

Opens that looked like a person, with repeat fetches within thirty seconds collapsed. A preview pane redrawing is not a second reading. Through Gmail this is a floor and not a total: its proxy fetches the image once and caches it, so later readings never reach us.

clickCountinteger

Counted clicks. Stronger evidence than an open, and worth weighting as such: images are blocked far more often than links go unfollowed, so a message with clicks and no opens was certainly read.

openCountRawinteger

Every open hit, the automated ones included. openCountRaw - openCount is everything that was filtered out: Apple Mail Privacy Protection and corporate link scanners, which fetch on delivery whether or not a person ever looks, and alongside them the repeat fetches collapsed by the thirty-second window. Both are recorded and neither is counted, because discarding them outright would leave a gap in the log that nothing could explain. Do not read the difference as a machine count on its own. A message reopened twice in a minute lands in it too.

clickCountRawinteger

As openCountRaw, for clicks.

firstOpenAtstring

Peut être nullFormatdate-time

lastOpenAtstring

Peut être nullFormatdate-time

firstClickAtstring

Peut être nullFormatdate-time

lastClickAtstring

Peut être nullFormatdate-time

recipientsobject[]

One entry per tracked copy, which is not always one entry per person. Absent only from the trimmed form on a GET /emails row; every /tracking response carries it, list included.

emailstring: Null where the bytes could not be varied per person: an encrypted message, one too large to rebuild for each recipient, or a fallback carrier that takes the whole recipient list in a single call. The reading is real; which of the recipients did it is not knowable, and the only honest rendering is "someone on this message", never a name chosen out of the list.
Peut être null
kindstring: Peut être nullL'un de"to""cc""bcc"
attributedboolean: False on exactly the rows described above. Branch on this rather than on email being a string, and show nothing where it is false: attributing an unattributed open to a named recipient invents evidence about a specific person.
openCountinteger
clickCountinteger
firstOpenAtstring: Peut être nullFormatdate-time
lastOpenAtstring: Peut être nullFormatdate-time
firstClickAtstring: Peut être nullFormatdate-time
lastClickAtstring: Peut être nullFormatdate-time

linksobject[]

The rewritten links, in the order they appeared in the message. Only links in the new part of the body are here: the quoted history under a reply belongs to whoever wrote it, and routing their URLs through our redirector would both rewrite their message and record the recipient "clicking" something we did not put there. Repeated destinations share one entry, because a campaign page linked from a header image, a button and a footer is one question asked three times. Absent only from the trimmed form on a GET /emails row.

idstring
urlstring: Where it actually goes: the original href.
labelstring: The text the link read as in the message, where it had any. A bare URL rarely tells the sender which of five links somebody followed.
Peut être null
clickCountinteger
clickCountRawinteger

`UploadedTemplateImage`object

objectstringObligatoire: L'un de"template_image"
idstringObligatoire
urlstringObligatoire: The public address of the image.
Formaturi
sizeintegerObligatoire: Bytes, as stored.
widthinteger: Pixels, as stored.
heightinteger: Pixels, as stored.