Templates
Every operation in this group: what it accepts, what it returns and the errors it can answer with.
Operations
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
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.
Query parameters
limitintegerDefaults to 25. The bound lives in the service, so it is not in the schema.
At least 1At most 100cursorstringThe
nextCursoryou were handed, passed back as it came and never one you build. It is opaque: it holds thesortit 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 whicheversortyou 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 anothersort, is a 400invalid_cursor.1 to 2048 charactersstatusstringNarrows to drafts, active or archived templates. Omit for all three.
drafthere is the template's own status, not "has an unpublished draft", which every template has.One of"draft""active""archived"searchstringMatches 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.Up to 200 characterssortstringThe order, and the field the cursor keys on.
updated-newestis 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.One of"updated-newest""updated-oldest""created-newest""created-oldest""name""name-reversed"
Returns
A page, most recently updated first.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
POST/templates
Create a template
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.
Request body
namestringRequiredDisplay name, 1 to 100 characters after trimming and unique per workspace.
1 to 100 charactersslugstringStable handle of lowercase letters, digits and hyphens, at most 64 characters. Derived from
namewhen omitted.Up to 64 charactersPattern^[a-z0-9][a-z0-9-]*$descriptionstringFree text note, at most 500 characters.
Can be nullUp to 500 characterspublishbooleanCompiles and publishes version 1 immediately. Defaults to false, which leaves a draft.
DefaultfalsestarterstringA 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.Up to 64 charactersenginestringblocksorhtml. Inferred from whetherhtmlis present.One of"blocks""html"subjectstringSubject line with optional
{{placeholders}}, at most 998 characters and free of line breaks.Up to 998 charactersdocumentobjectThe body of a
blockstemplate: the block tree plus the page settings wrapped around it. Anhtmltemplate has none of this and carrieshtmlinstead.It REPLACES wholesale. A PATCH that sends
documentsends the whole document, so a call that rebuildsbodyand omitsfontsdrops the fonts. Read the head withGET /templates/{id}(or an older revision withGET /templates/{id}/versions/{version}), change what you mean to change, and post the result back.bodyobject[]RequiredThe blocks, in order, 500 at most across the whole tree. Each is an object with a
kindof 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 ownchildren, 8 deep at most.Up to 500 itemspreviewstringPreview 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.
Up to 256 characterstailwindbooleanRead 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.
DefaultfalsefontsTemplateFont[]Web fonts to load, 8 at most. This is the only place fonts are declared; a
font-familyon a block refers to a family named here or to one already on the reader's machine.Up to 8 itemsstyleobjectPage 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
slotson 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.
htmlstringPre-rendered markup for the
htmlengine. Required for it, at most 1,000,000 characters.Up to 1000000 charactersslotsTemplateSlot[]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.
Returns
Created, with version 1.
Errors
- 409
template_name_takenortemplate_slug_taken. Both are per workspace.- 422
invalid_template(withparamnaming the offending path, down to the block) orworkspace_limit_reachedwhen the workspace is at its template limit.
The errors every operation can return400401403404500Error catalog
Also available in
GET/templates/fonts
List the web fonts a template can load
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.
Returns
The 17 fonts, in the order the console offers them.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/templates/starters
List the starter designs
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.
Returns
Every starter, bodies left out.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/templates/starters/{slug}
Retrieve one starter
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.
Path parameters
slugstringRequiredA starter slug exactly as
GET /templates/startersreports it. Starters are part of the product rather than workspace data, so the same slugs answer for every key.
Returns
The starter with its block tree and a rendered preview.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
POST/templates/render
Render a body that is not stored
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.
Request body
enginestringDefaults to
htmlwhenhtmlis sent andblocksotherwise.One of"blocks""html"subjectstringThe subject to render, at most 998 characters.
Up to 998 charactersdocumentobjectThe body of a
blockstemplate: the block tree plus the page settings wrapped around it. Anhtmltemplate has none of this and carrieshtmlinstead.It REPLACES wholesale. A PATCH that sends
documentsends the whole document, so a call that rebuildsbodyand omitsfontsdrops the fonts. Read the head withGET /templates/{id}(or an older revision withGET /templates/{id}/versions/{version}), change what you mean to change, and post the result back.bodyobject[]RequiredThe blocks, in order, 500 at most across the whole tree. Each is an object with a
kindof 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 ownchildren, 8 deep at most.Up to 500 itemspreviewstringPreview 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.
Up to 256 characterstailwindbooleanRead 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.
DefaultfalsefontsTemplateFont[]Web fonts to load, 8 at most. This is the only place fonts are declared; a
font-familyon a block refers to a family named here or to one already on the reader's machine.Up to 8 itemsstyleobjectPage 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
slotson 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.
htmlstringThe markup for the
htmlengine, at most 1,000,000 characters.Up to 1000000 charactersslotsTemplateSlot[]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.
markbooleanLeaves placeholders as
{{key}}rather than substituting them.valuesobjectpropsRecord<string, any>slotsRecord<string, any>
Returns
The rendered subject, HTML and text.
Errors
- 422
invalid_template, withparamnaming the offending path.
The errors every operation can return400401403404500Error catalog
Also available in
GET/templates/{id}
Retrieve a template
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.
Path parameters
idstringRequiredA
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.
Returns
The template, with its head version in full.
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time latestTemplateVersion
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
PATCH/templates/{id}
Update a template
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.
Path parameters
idstringRequiredA
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.
Request body
namestringReplacement name, 1 to 100 characters and unique per workspace. The slug does not follow it.
1 to 100 charactersslugstringReplacement 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.Up to 64 charactersPattern^[a-z0-9][a-z0-9-]*$descriptionstringReplacement note of at most 500 characters, or null to clear it.
Can be nullUp to 500 charactersstatusstringArchives or reactivates the template. It cannot be set back to
draft.One of"active""archived"expectedVersionintegerThe head version number you edited from. A mismatch is a 409
version_conflictand nothing is written.More than 0enginestringSwitches between
blocksandhtml. Switching tohtmlneedshtmlsupplied or already stored.One of"blocks""html"subjectstringReplacement subject, at most 998 characters and free of line breaks.
Up to 998 charactersdocumentobjectThe body of a
blockstemplate: the block tree plus the page settings wrapped around it. Anhtmltemplate has none of this and carrieshtmlinstead.It REPLACES wholesale. A PATCH that sends
documentsends the whole document, so a call that rebuildsbodyand omitsfontsdrops the fonts. Read the head withGET /templates/{id}(or an older revision withGET /templates/{id}/versions/{version}), change what you mean to change, and post the result back.bodyobject[]RequiredThe blocks, in order, 500 at most across the whole tree. Each is an object with a
kindof 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 ownchildren, 8 deep at most.Up to 500 itemspreviewstringPreview 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.
Up to 256 characterstailwindbooleanRead 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.
DefaultfalsefontsTemplateFont[]Web fonts to load, 8 at most. This is the only place fonts are declared; a
font-familyon a block refers to a family named here or to one already on the reader's machine.Up to 8 itemsstyleobjectPage 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
slotson 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.
htmlstringReplacement markup for the
htmlengine, at most 1,000,000 characters.Up to 1000000 charactersslotsTemplateSlot[]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.
Returns
Saved. latest is the draft this edit wrote into.
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time latestTemplateVersion
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
DELETE/templates/{id}
Delete a template
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.
Path parameters
idstringRequiredA
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.
Returns
Deleted.
objectstring- One of
"template" idstringdeletedboolean- One of
true
Errors
- 409
template_in_use: a broadcast that is scheduled or queued still names this template. Cancel it, or wait until it starts sending.
The errors every operation can return400401403404422500Error catalog
Also available in
POST/templates/{id}/duplicate
Copy a template
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.
Path parameters
idstringRequiredA
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.
Request body
namestringThe name for the copy, 1 to 100 characters. Omit it to reuse the source name with a number appended.
1 to 100 characters
Returns
The new template, at version 1 as a draft.
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time latestTemplateVersion
Errors
- 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.
The errors every operation can return400401403404500Error catalog
Also available in
POST/templates/{id}/content
Replace the design
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.
Path parameters
idstringRequiredA
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.
Request body
starterstringA starter slug from
listStarters. Mutually exclusive withfromTemplateId.Up to 64 charactersfromTemplateIdstringAnother template in this workspace to borrow the design from, by id or slug. Mutually exclusive with
starter.1 to 128 charactersexpectedVersionintegerThe head version you read before replacing. A mismatch is a 409
version_conflictand nothing is written.More than 0
Returns
Replaced. latest is the version this call wrote into.
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time latestTemplateVersion
Errors
- 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.
The errors every operation can return400401403404500Error catalog
Also available in
GET/templates/{id}/versions
List versions
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.
Path parameters
idstringRequiredA
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.
Query parameters
limitintegerRows per page, 1 to 100.
At least 1At most 100Default25cursorstringThe 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 400invalid_cursor.
Returns
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.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
POST/templates/{id}/versions
Publish the draft
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.
Path parameters
idstringRequiredA
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.
Returns
Published. Live sends resolve to this from now on.
objectstring- One of
"template_version" idstringtplv_+ 24 hex. Not the template id.templateIdstringversionintegerCounts from 1, per template. This is what a send pins.
statestringThere 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.
One of"draft""published"enginestring- One of
"blocks""html" subjectstringslotsTemplateSlot[]propsTemplateProp[]documentobjectThe body of a
blockstemplate: the block tree plus the page settings wrapped around it. Anhtmltemplate has none of this and carrieshtmlinstead.It REPLACES wholesale. A PATCH that sends
documentsends the whole document, so a call that rebuildsbodyand omitsfontsdrops the fonts. Read the head withGET /templates/{id}(or an older revision withGET /templates/{id}/versions/{version}), change what you mean to change, and post the result back.Can be nullbodyobject[]RequiredThe blocks, in order, 500 at most across the whole tree. Each is an object with a
kindof 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 ownchildren, 8 deep at most.Up to 500 itemspreviewstringPreview 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.
Up to 256 characterstailwindbooleanRead 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.
DefaultfalsefontsTemplateFont[]Web fonts to load, 8 at most. This is the only place fonts are declared; a
font-familyon a block refers to a family named here or to one already on the reader's machine.Up to 8 itemsstyleobjectPage 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
slotson 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.
htmlstringThe markup exactly as it was submitted, for the
htmlengine, and not what goes out: sanitising happens at publish, against the compiled copy. Returned wheredocumentis.Can be nullpublishedAtstring- Can be nullFormat
date-time createdAtstring- Format
date-time templateTemplate
Errors
- 409
version_conflict: another writer published between your read and this call.- 422
invalid_template. The draft does not compile; nothing was published.
The errors every operation can return400401403404500Error catalog
Also available in
GET/templates/{id}/versions/{version}
Retrieve one version
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.
Path parameters
idstringRequiredA
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.versionintegerRequiredA version NUMBER as
GET /templates/{id}/versionsreports it, counting from 1, not atplv_id. Numbers are never reused, so a deleted one stays gone.At least 1
Returns
That revision, body included.
Errors
- 404
template_version_not_found: no version with that number, or it was deleted.
The errors every operation can return400401403422500Error catalog
Also available in
DELETE/templates/{id}/versions/{version}
Delete one version
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.
Path parameters
idstringRequiredA
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.versionintegerRequiredA version NUMBER as
GET /templates/{id}/versionsreports it, counting from 1, not atplv_id. Numbers are never reused, so a deleted one stays gone.At least 1
Returns
Deleted.
objectstring- One of
"template_version" templateIdstringversionintegerdeletedboolean- One of
true
Errors
- 422
template_version_not_deletable: the version is the live one, the head being edited, or the only version there is.
The errors every operation can return400401403404500Error catalog
Also available in
POST/templates/{id}/versions/{version}/restore
Restore an older version
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.
Path parameters
idstringRequiredA
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.versionintegerRequiredA version NUMBER as
GET /templates/{id}/versionsreports it, counting from 1, not atplv_id. Numbers are never reused, so a deleted one stays gone.At least 1
Request body
expectedVersionintegerThe head version you read before restoring. A mismatch is a 409
version_conflictand nothing is written.More than 0
Returns
Restored into the head. Nothing live has moved.
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time latestTemplateVersionrestoredFromintegerThe version the body was copied from.
Errors
- 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.
The errors every operation can return400401403404500Error catalog
Also available in
POST/templates/{id}/preview
Render without sending
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.
Path parameters
idstringRequiredA
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.
Request body
versionintegerVersion to render, drafts included. Defaults to the published version.
More than 0propsRecord<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.
Returns
The rendered subject, HTML and text.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/templates/{id}/analytics
How a template has performed
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.
Path parameters
idstringRequiredA
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.
Query parameters
daysintegerHow 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.
At least 1At most 365minutesintegerThe 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.At least 1At most 1576800grainstringHow wide one
byDaybucket is, and the shape of its key:YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MM.One of"minute""hour""day"offsetMinutesintegerThe reader's UTC offset in minutes, so a day is their day rather than UTC's.
At least -840At most 840
Returns
The engagement report for this template.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/templates/{id}/sends
The messages a template sent
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.
Path parameters
idstringRequiredA
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.
Query parameters
daysintegerHow far back to look. Defaults to 30.
At least 1At most 365minutesintegerThe window in minutes, which wins over
days.At least 1At most 1576800grainstringOnly 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.
One of"minute""hour""day"offsetMinutesintegerThe reader's UTC offset in minutes.
At least -840At most 840pageintegerWhich page, from 1. Defaults to 1. Page numbers, not a cursor, because the console shows a table with a total.
At least 1pageSizeintegerRows per page, 1 to 100. Defaults to 25.
At least 1At most 100searchstringMatches the subject that went out and the recipient addresses.
Up to 200 characterssourcestringOnly sends from one surface, such as the API or the console.
Up to 64 charactersversionintegerOnly sends that rendered this version number.
More than 0openedstringTrue for sends with at least one counted open, false for none of them.
One of"true""false"clickedstringTrue for sends with at least one counted click, false for none of them.
One of"true""false"trackedstringTrue for sends that carried tracking at all. The false side is the mail that could never have reported anything.
One of"true""false"
Returns
One row per message, newest first, with the total matching the filters.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
POST/templates/{id}/send
Send with a template
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.
Path parameters
idstringRequiredA
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.
Headers
Idempotency-KeystringMakes a retry safe. Reusing one with a different body is a 422.
Up to 255 charactersPattern^[A-Za-z0-9_.:-]+$
Request body
fromstring | objectRequiredSender as
address,Name <address>or{ email, name }. The key must be allowed to send as it, otherwise 403from_address_forbidden.emailstringRequired- Up to 320 characters
namestring- Up to 128 characters
to(string | object)[]Required1 to 50 recipients. The SDK wraps a single value in an array.
1 to 50 itemsemailstringRequired- Up to 320 characters
namestring- Up to 128 characters
cc(string | object)[]Up to 50 copied recipients.
Up to 50 itemsDefault[]emailstringRequired- Up to 320 characters
namestring- Up to 128 characters
bcc(string | object)[]Up to 50 blind copied recipients.
Up to 50 itemsDefault[]emailstringRequired- Up to 320 characters
namestring- Up to 128 characters
replyTostring | objectSets the Reply-To header.
emailstringRequired- Up to 320 characters
namestring- Up to 128 characters
versionintegerPublished version to send. Defaults to the currently published one.
More than 0propsRecord<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.
subjectstringReplaces the version's subject for this message, sent verbatim, at most 998 characters.
Up to 998 charactersscheduledAtstringWhen to send: a
Date, an ISO 8601 instant or a duration likePT2H. Must be in the future and at most 365 days out.3 to 64 characterscancellableForSecondsintegerHolds the message 0 to 900 seconds so it can still be cancelled. Defaults to 0 and is refused alongside
scheduledAt.At least 0At most 900Default0trackingobjectPer message
opensandclicksswitches for open and click tracking.opensbooleanclicksboolean
translateobjectTranslates the rendered message into
tobefore sending, with optionalfrom,includeOriginal(default true) andsubject(default true).tostringRequired- 2 to 60 characters
fromstring- 2 to 60 characters
includeOriginalboolean- Default
true subjectboolean- Default
true
tagsRecord<string, string>Your own labels for the send, keys up to 64 and values up to 256 characters.
Default{}
Returns
An Idempotency-Key replayed an earlier send. This is that message, not a new one.
objectstring- One of
"email" idstringThe durable handle,
msg_+ 24 hex.statusstring- One of
"queued""scheduled""sending""sent""partial""cancelled""failed" modestring- One of
"live""test" fromstringsubjectstring- Can be null
messageIdstringRFC 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, asemailId.Can be nullthreadIdstring- Can be null
transportstringHow the bytes left, once they have. Null until dispatch.
testis what a message sent with anoe_test_key records: it was accepted and every recipient marked delivered, but nothing was carried.devis 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.Can be nullOne of"ses""test""dev"attemptsintegerlastErrorstring- Can be null
scheduledAtstring- Can be nullFormat
date-time cancellableUntilstring- Can be nullFormat
date-time sentAtstring- Can be nullFormat
date-time tagsRecord<string, string>broadcastIdstringThe
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.Can be nullsourcestring- One of
"api""oauth""composer""mcp""ai""form" createdAtstring- Format
date-time recipientsobject[]Returned on retrieval only.
emailstringnamestring- Can be null
kindstring- One of
"to""cc""bcc" statusstringuncertainis 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.suppressedis 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.One of"pending""delivered""failed""bounced""complained""suppressed""uncertain"errorstring- Can be null
deliveredAtstring- Can be nullFormat
date-time
translationobjectPresent 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.
languagestringThe resolved target code:
de,pt-BR.languageNamestringIts English name.
detectedSourceLanguagestringStated or detected. Null when detection abstained.
Can be nullsubjectbooleanWhether the subject was translated too.
includeOriginalbooleanWhether the sender's own words went below the translation.
trackingTrackingtemplateobjectidstringversioninteger- Can be null
Accepted. template.version is the version that went out, whether you pinned it or the published one was resolved.
objectstring- One of
"email" idstringThe durable handle,
msg_+ 24 hex.statusstring- One of
"queued""scheduled""sending""sent""partial""cancelled""failed" modestring- One of
"live""test" fromstringsubjectstring- Can be null
messageIdstringRFC 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, asemailId.Can be nullthreadIdstring- Can be null
transportstringHow the bytes left, once they have. Null until dispatch.
testis what a message sent with anoe_test_key records: it was accepted and every recipient marked delivered, but nothing was carried.devis 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.Can be nullOne of"ses""test""dev"attemptsintegerlastErrorstring- Can be null
scheduledAtstring- Can be nullFormat
date-time cancellableUntilstring- Can be nullFormat
date-time sentAtstring- Can be nullFormat
date-time tagsRecord<string, string>broadcastIdstringThe
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.Can be nullsourcestring- One of
"api""oauth""composer""mcp""ai""form" createdAtstring- Format
date-time recipientsobject[]Returned on retrieval only.
emailstringnamestring- Can be null
kindstring- One of
"to""cc""bcc" statusstringuncertainis 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.suppressedis 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.One of"pending""delivered""failed""bounced""complained""suppressed""uncertain"errorstring- Can be null
deliveredAtstring- Can be nullFormat
date-time
translationobjectPresent 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.
languagestringThe resolved target code:
de,pt-BR.languageNamestringIts English name.
detectedSourceLanguagestringStated or detected. Null when detection abstained.
Can be nullsubjectbooleanWhether the subject was translated too.
includeOriginalbooleanWhether the sender's own words went below the translation.
trackingTrackingtemplateobjectidstringversioninteger- Can be null
Errors
- 409
domain_not_sendable: thefromdomain cannot sign mail yet, so nothing was accepted.- 422
The props did not satisfy the version:
missing_template_prop,unknown_template_prop,unknown_template_slotorinvalid_template_prop, each withparamnaming the key. Alsotemplate_not_publishedwhen nothing has been published yet.
The errors every operation can return400401403404500Error catalog
Also available in
GET/templates/images
List template images
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.
Query parameters
limitintegerRows per page, 1 to 120.
At least 1At most 120Default24cursorstringThe 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 400invalid_cursor.
Returns
A page of images.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
POST/templates/images
Upload a template image
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.
Request body
Content typeimage/png, image/jpeg, image/webp, image/gif, image/svg+xml
Returns
Stored. Use url in a template.
Errors
- 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.
The errors every operation can return400401403404500Error catalog
Also available in
POST/templates/design
Design a template from a brief
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.
Request body
namestringRequiredA short name for the template. When the name is taken, a free one is chosen and returned.
1 to 100 charactersbriefstringRequiredEverything the design must hold and look like, up to 8,000 characters.
1 to 8000 charactersdescriptionstringOne line about what it is for.
Up to 500 charactersstarterstringThe slug of a starter design to build on, from
listStarters.1 to 64 charactersimageFileIdsstring[]Up to ten file ids of images to place in the design.
Up to 10 itemspublishbooleanPublish it at once so it can be sent. Defaults to false.
Returns
The new template.
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time designobjectsubjectstringThe subject the designer wrote or kept.
notesstring[]What was adjusted while saving the design.
imageProblemsstring[]Each image in
imageFileIdsthat could not be used, and why.
Errors
- 409
ai_not_configured: this server has no model to design with.- 422
invalid_templatewhen the design could not be made valid, or the template is raw HTML.invalid_parameterfor a body that does not validate.- 429
ai_quota_exceeded: the workspace has used its AI actions for today.
The errors every operation can return400401403404500Error catalog
Also available in
POST/templates/{id}/redesign
Change a template’s design from instructions
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.
Path parameters
idstringRequired
Request body
instructionsstringRequiredWhat to change, with every detail: the words, colours and which section. Up to 8,000 characters.
1 to 8000 charactersimageFileIdsstring[]Up to ten file ids of images to use.
Up to 10 itemsexpectedVersionintegerThe version you based the change on. A newer one is refused with 409
version_conflict.More than 0
Returns
The template, with design.changes and the draft version that holds them.
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time designobjectsubjectstringThe subject the designer wrote or kept.
notesstring[]What was adjusted while saving the design.
imageProblemsstring[]Each image in
imageFileIdsthat could not be used, and why.
Errors
- 409
ai_not_configured: this server has no model to design with.- 422
invalid_templatewhen the design could not be made valid, or the template is raw HTML.invalid_parameterfor a body that does not validate.- 429
ai_quota_exceeded: the workspace has used its AI actions for today.
The errors every operation can return400401403404500Error catalog
Also available in
Objects
Templateobject
objectstring- One of
"template" idstringThe durable handle,
tpl_+ 24 hex.namestringslugstringDerived 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- Can be null
statusstringWhether anybody is meant to reach for it, which is not the same question as whether it has a published version.
archivedis the reversible form of deleting one.One of"draft""active""archived"publishedVersionintegerThe 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_publishedrather than quietly going out as whatever the draft currently says.Can be nulllatestVersionintegerThe head. Equal to
publishedVersionuntil somebody edits the body, which mints the next draft and leaves live sends on the published one.subjectstringThe 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.enginestringblocksis a validated tree over the exports of@react-email/components, checked at its input.htmlis markup the caller rendered themselves, sanitised once at publish. Absent when nothing is published, for the same reasonsubjectis: it is a property of a version, not of the template.One of"blocks""html"slotsTemplateSlot[]The published version's declarations. Absent when nothing is published.
propsTemplateProp[]What a send must supply. Read the
requiredones off this rather than off a preview: a preview tolerates them being missing and a send does not.createdAtstring- Format
date-time updatedAtstring- Format
date-time
TemplateAnalyticsobject
objectstring- One of
"template_analytics" templateIdstringAlways the
tpl_id, even when a slug was asked for.sendsintegerMessages this template rendered in the window, live keys only. A test-key send is counted in
lifetime.testSendsand nowhere else.matchedintegerHow many of those renders were paired with a tracked message. The gap between this and
sendsis mail that carried no tracking at all, not data that went missing.trackedForOpensintegerThe denominator behind
openRate. Counting untracked sends in it would quietly lower every rate.trackedForClicksintegerThe denominator behind
clickRate.openedintegerSends with at least one counted open.
clickedintegerSends with at least one counted click.
openRatenumberA percentage to one decimal place, over
trackedForOpens. Zero rather than null when nothing was tracked.clickRatenumberThe same, over
trackedForClicks.totalOpensintegerEvery counted open, repeats included.
totalClicksintegerbySourceobject[]Which surface sent it: the API, the console, a rule, the assistant.
sourcestringsendsinteger
byDayobject[]One entry per bucket at the grain you asked for. The key is
YYYY-MM-DDfor a day,YYYY-MM-DDTHHfor an hour,YYYY-MM-DDTHH:MMfor a minute.daystringsentintegersendsintegertrackedForOpensintegertrackedForClicksintegeropenedintegerclickedinteger
byVersionobject[]The same figures per version, newest first, which is how a redesign is compared with what it replaced.
versionintegersendsintegertrackedForOpensintegertrackedForClicksintegeropenedintegerclickedinteger
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.idstringversionintegersourcestringcreatedAtstring- Format
date-time matchedbooleanopensbooleanWhether the message asked to be tracked for opens.
clicksbooleanopenCountintegerclickCountinteger
lifetimeobjectIgnores the window entirely: every send this template has ever made.
sendsintegertestSendsintegerSent with a test key, so nothing was carried.
firstAtstring- Can be nullFormat
date-time lastAtstring- Can be nullFormat
date-time
TemplateFontobject
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.
fontFamilystringRequiredThe family name as the blocks reference it, for example
Playfair Display. Letters, digits, spaces, dots, hyphens, commas and quotes.Up to 128 charactersfallbackFontFamilystringRequiredWhat 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.Up to 128 characterswebFontobjectWhere 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.
urlstringRequiredThe url the named family is served from, exactly as
GET /templates/fontsreports 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.One of"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"formatstringRequired- One of
"woff2""woff""truetype""opentype""embedded-opentype""svg"
fontWeightstring | integerA number, a keyword (
normal,bold,bolder,lighter), or two numbers for a variable range, as in100 900.fontStylestring- One of
"normal""italic""oblique"
TemplateFontCatalogueEntryobject
One font this API will serve inside a template. The catalogue is the whole of what fonts[].webFont.url accepts.
objectstring- One of
"template_font" familystringThe family name to put in
fonts[].fontFamilyand in a block'sfont-family.fallbackstringThe email safe family to put in
fallbackFontFamily. It is what a client that refuses the download renders.stackstringThe whole CSS font stack, family first and fallbacks behind it, ready to drop into a
font-familystyle.weightstringWhat the file carries: one weight, as in
400, or two numbers for a variable range, as in100 900. Asking for a weight outside it makes the client synthesise one.formatstring- One of
"woff2" urlstringThe url to put in
fonts[].webFont.url. No other url is accepted for this family.
TemplateFontListobject
objectstring- One of
"list"
TemplateImageobject
objectstringRequired- One of
"template_image" idstringRequiredurlstringRequiredThe public address of the image.
FormaturisizeintegerRequiredBytes, as stored.
TemplateImageListobject
objectstring- One of
"list" dataTemplateImage[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringAn opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Can be null
TemplateListobject
objectstring- One of
"list" dataTemplate[]hasMorebooleannextCursorstring- Can be null
TemplatePreviewobject
objectstring- One of
"template_preview" templateIdstringversionintegerWhich revision was rendered, resolved rather than echoed, so a preview that named no version records what "published" meant at that moment.
subjectstringWith its placeholders already filled.
htmlstringByte for byte what a send with these values would put in the message.
textstringThe
text/plainalternative, 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.
codestringunfilled_placeholdertoday. Treat an unrecognised code as a warning.keystring
TemplatePropobject
keystringA letter followed by letters, digits or underscores. This is what
{{key}}in the subject or the body refers to, and what a send names inpropsorslots.labelstringFor whoever fills it in. Never rendered into the message.
kindstringHow a supplied value is escaped when it lands in the body.
textbecomes a React child, so React escapes it;urlandimageare parsed and scheme-checked before they reach anhrefor asrc. The kind is declared rather than sniffed from the value, because a string that happens to start withhttps:is not evidence that the author meant it to be followed.One of"text""url""image"requiredbooleanA 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.
defaultstringUsed 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.
Can be null
TemplateRenderobject
objectstring- One of
"template_render" subjectstringWith its placeholders filled, or marked when asked.
htmlstringWhat 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.
textstringThe
text/plainalternative, 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.
codestringunfilled_placeholdertoday. Treat an unrecognised code as a warning.keystring
TemplateSendobject
objectstring- One of
"template_send" idstringThe render id,
tplr_+ hex. Not the message id.versionintegerThe version this message rendered.
sourcestringsubjectstringAs it went out, with the placeholders already filled.
createdAtstring- Format
date-time recipientsstring[]matchedbooleanWhether 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.
opensbooleanWhether the message asked to be tracked for opens.
clicksbooleanopenCountintegerWhat actually happened, as opposed to what was asked for.
clickCountinteger
TemplateSendListobject
objectstring- One of
"list" dataTemplateSend[]totalintegerRows matching the filters, not rows on this page.
pageintegerpageSizeinteger
TemplateSlotobject
keystringA letter followed by letters, digits or underscores. This is what
{{key}}in the subject or the body refers to, and what a send names inpropsorslots.labelstringFor whoever fills it in. Never rendered into the message.
kindstringHow a supplied value is escaped when it lands in the body.
textbecomes a React child, so React escapes it;urlandimageare parsed and scheme-checked before they reach anhrefor asrc. The kind is declared rather than sniffed from the value, because a string that happens to start withhttps:is not evidence that the author meant it to be followed.One of"text""url""image"defaultstringWhat 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.
TemplateStarterobject
objectstring- One of
"template_starter" slugstringThe handle to send as
starteron 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.namestringdescriptionstringcategorystringHow the console groups the picker. Nothing behaves differently per category.
One of"account""commerce""notify""marketing"subjectstringThe 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.
TemplateStarterDetailobject
objectstring- One of
"template_starter" slugstringThe handle to send as
starteron 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.namestringdescriptionstringcategorystringHow the console groups the picker. Nothing behaves differently per category.
One of"account""commerce""notify""marketing"subjectstringThe 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.
documentobjectThe body of a
blockstemplate: the block tree plus the page settings wrapped around it. Anhtmltemplate has none of this and carrieshtmlinstead.It REPLACES wholesale. A PATCH that sends
documentsends the whole document, so a call that rebuildsbodyand omitsfontsdrops the fonts. Read the head withGET /templates/{id}(or an older revision withGET /templates/{id}/versions/{version}), change what you mean to change, and post the result back.bodyobject[]RequiredThe blocks, in order, 500 at most across the whole tree. Each is an object with a
kindof 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 ownchildren, 8 deep at most.Up to 500 itemspreviewstringPreview 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.
Up to 256 characterstailwindbooleanRead 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.
DefaultfalsefontsTemplateFont[]Web fonts to load, 8 at most. This is the only place fonts are declared; a
font-familyon a block refers to a family named here or to one already on the reader's machine.Up to 8 itemsstyleobjectPage 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
slotson 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.
previewstringThe 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.
TemplateStarterListobject
objectstring- One of
"list"
TemplateVersionobject
objectstring- One of
"template_version" idstringtplv_+ 24 hex. Not the template id.templateIdstringversionintegerCounts from 1, per template. This is what a send pins.
statestringThere 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.
One of"draft""published"enginestring- One of
"blocks""html" subjectstringslotsTemplateSlot[]propsTemplateProp[]documentobjectThe body of a
blockstemplate: the block tree plus the page settings wrapped around it. Anhtmltemplate has none of this and carrieshtmlinstead.It REPLACES wholesale. A PATCH that sends
documentsends the whole document, so a call that rebuildsbodyand omitsfontsdrops the fonts. Read the head withGET /templates/{id}(or an older revision withGET /templates/{id}/versions/{version}), change what you mean to change, and post the result back.Can be nullbodyobject[]RequiredThe blocks, in order, 500 at most across the whole tree. Each is an object with a
kindof 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 ownchildren, 8 deep at most.Up to 500 itemspreviewstringPreview 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.
Up to 256 characterstailwindbooleanRead 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.
DefaultfalsefontsTemplateFont[]Web fonts to load, 8 at most. This is the only place fonts are declared; a
font-familyon a block refers to a family named here or to one already on the reader's machine.Up to 8 itemsstyleobjectPage 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
slotson 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.
htmlstringThe markup exactly as it was submitted, for the
htmlengine, and not what goes out: sanitising happens at publish, against the compiled copy. Returned wheredocumentis.Can be nullpublishedAtstring- Can be nullFormat
date-time createdAtstring- Format
date-time
TemplateVersionListobject
objectstring- One of
"list" hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringAn opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Can be null
Trackingobject
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.
objectstringPresent when the report is the whole response body. Absent under an email's
trackingfield, which is part of that email rather than a resource in its own right.One of"tracking"idstringThe tracking record,
tmsg_+ 24 hex. Not the message id and not the send id.sendIdstringThe
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.Can be nullthreadIdstring- Can be null
messageIdstringRFC 5322 Message-ID. Not a correlation key. The header is rewritten on the way out. Correlate on
id.Can be nullsubjectstring- Can be null
fromstringsourcestring- One of
"api""oauth""composer""mcp""ai""form" sentAtstring- Can be nullFormat
date-time opensbooleanWhat 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".
clicksbooleanAs
opens, for link rewriting. The two are independent switches.openedbooleanclickedbooleanattributablebooleanWhether 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.
recipientscarries the same fact one row at a time, and one row at a time is where it gets missed.openCountintegerOpens 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.
clickCountintegerCounted 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.
openCountRawintegerEvery open hit, the automated ones included.
openCountRaw - openCountis 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.clickCountRawintegerAs
openCountRaw, for clicks.firstOpenAtstring- Can be nullFormat
date-time lastOpenAtstring- Can be nullFormat
date-time firstClickAtstring- Can be nullFormat
date-time lastClickAtstring- Can be nullFormat
date-time recipientsobject[]One entry per tracked copy, which is not always one entry per person. Absent only from the trimmed form on a
GET /emailsrow; every/trackingresponse carries it, list included.emailstringNull 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.
Can be nullkindstring- Can be nullOne of
"to""cc""bcc" attributedbooleanFalse on exactly the rows described above. Branch on this rather than on
emailbeing a string, and show nothing where it is false: attributing an unattributed open to a named recipient invents evidence about a specific person.openCountintegerclickCountintegerfirstOpenAtstring- Can be nullFormat
date-time lastOpenAtstring- Can be nullFormat
date-time firstClickAtstring- Can be nullFormat
date-time lastClickAtstring- Can be nullFormat
date-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 /emailsrow.idstringurlstringWhere it actually goes: the original href.
labelstringThe 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.
Can be nullclickCountintegerclickCountRawinteger
UploadedTemplateImageobject
objectstringRequired- One of
"template_image" idstringRequiredurlstringRequiredThe public address of the image.
FormaturisizeintegerRequiredBytes, as stored.
widthintegerPixels, as stored.
heightintegerPixels, as stored.