SDK

openemail.templates

Chaque méthode de cet espace de noms : sa signature, ses paramètres, ce qu'elle retourne et un exemple.

Méthodes

Bodies stored once and sent many times, with versions, previews and typed props.

`templates.list()`

List templates, most recently updated first

templates:readParcourt les résultats page par page

Signature

list(options?: TemplateListOptions): Promise<Page<TemplateResource>>

Returns one page of the workspace's templates, ordered by updatedAt descending. Each row carries the published version's subject, engine, slots and props, so you can see what a send needs without fetching every template. A template with nothing published omits those four fields and reports publishedVersion as null.

Paging is keyset on updatedAt, and the cursor is opaque: it holds the sort and where the last template on the page sat in it, so a template deleted while you page never breaks the walk. Editing a template moves it to the front, so a template changed while you page can show up twice. Pass nextCursor back as options.cursor while hasMore is true, or let listAll or iterate walk the pages for you.

options.status narrows to one template status. draft is the status of a template created without publish and never published or activated since. It does not mean "has unpublished edits": check latestVersion against publishedVersion for that.

Paramètres

options.statusTemplateStatus: Restricts the page to draft, active or archived templates. Omit it for all of them.
options.searchstring: Matches the name, the slug, the description, the published version's subject and the id, each word loosely, with close spellings when nothing matches exactly, as a substring. % and _ are taken literally.
options.sortTemplateSort: The order: updated-newest (the default), updated-oldest, created-newest, created-oldest, name or name-reversed. The cursor follows whichever you asked for.
options.limitnumber: Rows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor from the previous page. Never build one yourself.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

Page<TemplateResource> with items, hasMore and nextCursor. Each template has id, name, slug, description, status, publishedVersion, latestVersion, createdAt and updatedAt, plus subject, engine, slots and props when a version is published.

Exemple

const page = await openemail.templates.list({ status: 'active', limit: 50 }) for (const template of page.items) {    console.log(template.slug, template.publishedVersion, template.latestVersion)} if (page.hasMore && page.nextCursor) {    const next = await openemail.templates.list({ status: 'active', limit: 50, cursor: page.nextCursor })    console.log(next.items.length)}

Remarques

A cursor is only valid under the sort it was handed out with. Keep sort and search the same while you page, which listAll and iterate do for you.
A cursor this list did not hand out, or one handed out under another sort, is a 400 invalid_cursor, not an empty page. Start again without a cursor.
publishedVersion lower than latestVersion means the body was edited after the last publish, and live sends still use the published version.
publishedVersion is null for a template that has never been published, here and on get, create and update alike.

Aussi disponible dans

API: GET /templates
CLI: openemail templates list

`templates.listAll()`

Collect every template into one array

templates:readParcourt les résultats page par page

Signature

listAll(options?: TemplateListOptions): Promise<Array<TemplateResource>>

Walks every page of the template list and resolves with all of them in a single array, most recently updated first. It follows nextCursor until hasMore is false, so the number of requests is the template count divided by the page size.

A workspace holds at most 200 templates, so passing limit: 100 normally finishes in two requests. options.status collects only one status. Paging is keyset on updatedAt, so a template edited by someone else during the walk can appear twice: de-duplicate on id if other writers are active.

Paramètres

options.statusTemplateStatus: Collects only draft, active or archived templates.
options.searchstring: Matches the name, the slug, the description, the published version's subject and the id, each word loosely.
options.sortTemplateSort: The order to walk in: updated-newest (the default), updated-oldest, created-newest, created-oldest, name or name-reversed.
options.limitnumber: Page size for each request, 1 to 100. The server defaults to 25.
options.cursorstring: Starts the walk from this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client API key for every page of this walk.

Retourne

Array<TemplateResource> holding every matching template, each with id, slug, status, publishedVersion and latestVersion, plus the published subject, engine, slots and props where one exists.

Exemple

const templates = await openemail.templates.listAll({ limit: 100 }) const unpublished = templates.filter((template) => template.publishedVersion === null) console.log(unpublished.map((template) => template.slug))

Remarques

Each page is a separate request. If one fails the promise rejects and the pages already fetched are discarded.
Archived templates count towards the 200 limit, and only delete frees a place.
Use iterate when you only need the first match, since it stops fetching once you break.

Aussi disponible dans

API: GET /templates

`templates.iterate()`

Stream templates one at a time

templates:readParcourt les résultats page par page

Signature

iterate(options?: TemplateListOptions): AsyncGenerator<TemplateResource, void, undefined>

Returns an async generator that yields templates individually and requests the next page only after the current one is drained. Nothing is fetched until you start consuming it, and breaking out of the loop stops further requests, so this is the cheapest way to find one template by a property the API cannot filter on.

The walk follows nextCursor and ends when hasMore is false, when a page comes back empty, or when the server repeats a cursor. Order is most recently updated first, so a template edited while you iterate can be yielded twice. Collect ids during the loop and act on them afterwards if you are also writing.

Paramètres

options.statusTemplateStatus: Yields only draft, active or archived templates.
options.searchstring: Matches the name, the slug, the description, the published version's subject and the id, each word loosely.
options.sortTemplateSort: The order to walk in: updated-newest (the default), updated-oldest, created-newest, created-oldest, name or name-reversed.
options.limitnumber: Page size per request, 1 to 100. The server defaults to 25.
options.cursorstring: Starts the walk from this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and ends the iteration.
options.apiKeystring: Overrides the client API key for every page of this walk.

Retourne

AsyncGenerator<TemplateResource, void, undefined> yielding one template per step.

Exemple

for await (const template of openemail.templates.iterate({ status: 'archived' })) {    if (template.name === 'Order shipped') {        console.log(template.id, template.slug, template.latestVersion)        break    }}

Remarques

An aborted options.signal rejects the pending page request, which throws out of the for await loop.
The generator is lazy, so an abandoned loop costs only the pages it consumed.

Aussi disponible dans

API: GET /templates

`templates.get()`

Read a template with its head version in full

templates:read

Signature

get(idOrSlug: string, options?: RequestScope): Promise<TemplateDetailResource>

Fetches one template by tpl_ id or by slug. Every templates method accepts either, and the two cannot collide because ids carry the tpl_ prefix while a slug has no underscores. Pin the slug in code: it is derived once at creation and never changes when the template is renamed.

latest is the head version, meaning the current draft, or the published version when nothing has been edited since. This is the only read that returns the body: document for the blocks engine, and html for the html engine exactly as submitted, before sanitising. The top level subject, engine, slots and props describe the published version, which is what a send uses, so they differ from latest while somebody has unpublished edits.

When nothing has been published yet, publishedVersion is null and the top level subject, engine, slots and props are absent. Read the draft from latest instead. Use list or listVersions to find out whether a template can actually be sent.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateDetailResource: the TemplateResource fields plus latest, a TemplateVersionResource with id, version, state, engine, subject, slots, props, document, html, publishedAt and createdAt.

Exemple

const template = await openemail.templates.get('order-shipped') console.log(template.id, template.publishedVersion, template.latest.version, template.latest.state) const required = (template.props ?? []).filter((prop) => prop.required).map((prop) => prop.key) console.log(required)

Remarques

A missing template is a 404 resource_not_found, whether it never existed or belongs to another workspace.
Read required props from the top level props, not from a preview. A preview tolerates a missing required prop and a send refuses it.
latest.html is the markup as you posted it. What goes out is the sanitised copy compiled at publish, which preview shows.

Aussi disponible dans

API: GET /templates/{id}
CLI: openemail templates get

`templates.create()`

Create a template and its first version

templates:write

Signature

create(body: TemplateCreate, options?: RequestScope): Promise<TemplateResource>

Creates the template together with version 1. Without publish: true that version is a draft, and a draft cannot be sent: send answers 422 template_not_published until somebody calls publish. With publish: true the body is compiled straight away and the template starts active, so a body that fails to render is refused here instead of later.

The engine follows what you send. Posting html selects the html engine, anything else is blocks. A blocks template stores a document whose body is a tree of @react-email/components nodes (Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock and CodeInline), validated on the way in with a ceiling of 500 nodes nested 8 deep. An html template stores markup you rendered yourself, for example with @react-email/render in your own build, and it is sanitised when the version is compiled.

{{key}} placeholders are filled from declared slots and props. A slot has a default and belongs to whoever edits the template. A prop is supplied by the sender and can be required. Keys start with a letter and continue with letters, digits or underscores, and one key cannot be both. In a blocks template an undeclared placeholder is a 422 invalid_template naming its path. In html markup, any placeholder used inside an attribute such as href or src must be declared with kind url or image, or compiling fails.

Paramètres

body.namestringObligatoire: Display name, 1 to 100 characters after trimming and unique per workspace.
body.slugstring: Stable handle of lowercase letters, digits and hyphens, at most 64 characters. Derived from name when omitted.
body.descriptionstring | null: Free text note, at most 500 characters.
body.publishboolean: Compiles and publishes version 1 immediately. Defaults to false, which leaves a draft.
body.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.
body.engineTemplateEngine: blocks or html. Inferred from whether html is present.
body.subjectstring: Subject line with optional {{placeholders}}, at most 998 characters and free of line breaks.
body.documentTemplateDocument: The blocks body: body (the block tree) plus the page settings that travel with it, preview, tailwind, fonts and style. Defaults to an empty body.
body.htmlstring: Pre-rendered markup for the html engine. Required for it, at most 1,000,000 characters.
body.slotsArray<Partial<TemplateSlot> & { key: string }>: Up to 100 editor filled values, each with key, optional label, kind (default text) and default (default empty string).
body.propsArray<Partial<TemplateProp> & { key: string }>: Up to 100 sender supplied values, each with key, optional label, kind (default text), required (default false) and default (default null).
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateResource with the new id and slug, status of draft or active, latestVersion of 1, and version 1's subject, engine, slots and props.

Exemple

const template = await openemail.templates.create({    name: 'Order shipped',    slug: 'order-shipped',    engine: 'html',    subject: 'Order {{orderId}} is on its way',    html: '<p>Hi {{customer}},</p><p>Order {{orderId}} has shipped. <a href="{{trackingUrl}}">Track it</a>.</p>',    props: [        { key: 'orderId', required: true },        { key: 'customer', default: 'there' },        { key: 'trackingUrl', kind: 'url', required: true }    ],    publish: true}) console.log(template.id, template.status)

Remarques

Without publish, the response reports publishedVersion: null and leaves out subject, engine, slots and props, because nothing is published yet.
A duplicate name is a 409 template_name_taken and a duplicate slug is a 409 template_slug_taken, both scoped to the workspace.
A workspace holds at most 200 templates, archived ones included. Creating one more is a 422 template_limit_reached.
Not retried by the SDK, since there is no idempotency key on this route. After a lost response, get the slug before trying again.

Aussi disponible dans

API: POST /templates
CLI: openemail templates create

`templates.update()`

Edit template metadata or its draft body

templates:write

Signature

update(idOrSlug: string, patch: TemplatePatch, options?: RequestScope): Promise<TemplateDetailResource>

Changes a template in place. name, description and status are metadata and never create a version. Sending any of subject, document, html, slots, props or engine is a body edit: if the head version is still a draft it is overwritten, and if the head is published a new draft numbered one higher is minted. Body fields you leave out keep the head's values, so a patch carrying only subject keeps the existing document and declarations, while slots or props replace the whole list.

Nothing here changes what a live send resolves to. Sends keep using the published version until you call publish, which is what makes it safe to edit a template in production. The response's latest is the version this call wrote into.

Pass expectedVersion with the latestVersion you read before editing. If another writer has moved the head since, the call fails with 409 version_conflict instead of overwriting their change. Without it the last write wins. Setting status: 'archived' is the reversible alternative to delete, but it does not block sends: an archived template with a published version still sends.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
patch.namestring: Replacement name, 1 to 100 characters and unique per workspace. The slug does not follow it.
patch.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.
patch.descriptionstring | null: Replacement note of at most 500 characters, or null to clear it.
patch.status'active' | 'archived': Archives or reactivates the template. It cannot be set back to draft.
patch.expectedVersionnumber: The head version number you edited from. A mismatch is a 409 version_conflict and nothing is written.
patch.engineTemplateEngine: Switches between blocks and html. Switching to html needs html supplied or already stored.
patch.subjectstring: Replacement subject, at most 998 characters and free of line breaks.
patch.documentTemplateDocument: The blocks body: body (the block tree) plus the page settings that travel with it, preview, tailwind, fonts and style. It replaces the whole document, so read the current one before rebuilding part of it. Revalidated in full.
patch.htmlstring: Replacement markup for the html engine, at most 1,000,000 characters.
patch.slotsArray<Partial<TemplateSlot> & { key: string }>: Complete replacement slot list.
patch.propsArray<Partial<TemplateProp> & { key: string }>: Complete replacement prop list.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateDetailResource with the saved metadata, the published version's fields at the top level, and latest set to the version this edit wrote into, including its document or html.

Exemple

const current = await openemail.templates.get('order-shipped') const updated = await openemail.templates.update('order-shipped', {    subject: 'Your order {{orderId}} has shipped',    expectedVersion: current.latestVersion}) console.log(updated.latest.version, updated.latest.state) await openemail.templates.publish('order-shipped')

Remarques

Not retried by the SDK. With expectedVersion set, repeating the call yourself after a lost response is a 409 if the first attempt minted a version.
An archived template refuses to send with 422 template_archived. publish sets status back to active, so publishing an archived template reactivates it.
The merged body is validated as a whole, so an edit can be refused with 422 invalid_template for what it does to fields you did not send.
Renaming onto another template's name is a 409 template_name_taken.

Aussi disponible dans

API: PATCH /templates/{id}
CLI: openemail templates update

`templates.duplicate()`

Copy a template into a new one

templates:write

Signature

duplicate(idOrSlug: string, body?: TemplateDuplicate, options?: RequestScope): Promise<TemplateDetailResource>

Creates a new template from the HEAD version of an existing one: the same subject, body, slots and props, and the source's description. The copy starts at version 1 as a DRAFT, whatever the source had published, so a copy is never sendable by accident. Publish it when you mean to.

The copy is a separate template with its own id and slug. Nothing links it back to the source, so editing either one afterwards leaves the other alone. This is 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 because a name is unique per workspace the server appends a number until one is free, up to twenty attempts. Sending a name that is already taken behaves the same way, so a script that copies nightly keeps working.

Paramètres

idOrSlugstringObligatoire: The template to copy, by tpl_ id or slug.
body.namestring: The name for the copy, 1 to 100 characters. Omit it to reuse the source name with a number appended.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateDetailResource for the NEW template, with latest set to its version 1 draft, including the copied document or html. 201.

Exemple

const copy = await openemail.templates.duplicate('order-shipped', { name: 'Order shipped, new design' }) console.log(copy.id, copy.slug, copy.latestVersion, copy.publishedVersion) await openemail.templates.update(copy.id, { subject: 'Your order is on the way' })

Remarques

The copy takes the source's HEAD, which is the unpublished draft when there is one. Duplicate after publishing if you want the live body.
Not retried by the SDK. Calling it twice makes two copies, each with its own numbered name.
A workspace at its 200 template limit is a 422 workspace_limit_reached, and nothing is copied.
Every name from the base to the base plus 20 being taken is a 409 template_name_taken.

Aussi disponible dans

API: POST /templates/{id}/duplicate
CLI: openemail templates duplicate

`templates.replaceContent()`

Swap a template's design for a starter or another template's

templates:write

Signature

replaceContent(idOrSlug: string, body: TemplateContentSource, options?: RequestScope): Promise<TemplateDetailResource>

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

The write lands exactly where an update to the body lands. A draft head is overwritten in place; a published head mints version N+1 as a draft. Sends keep resolving the published version until you publish, so this is safe to call on a template that is sending.

Name exactly one source. starter takes a slug from listStarters; fromTemplateId takes another template in the same workspace, whose published version is copied when it has one and whose draft is copied otherwise. Sending both, neither, or the target itself is a 422. A source in another workspace is a 404, like everything else here.

This discards the body it replaces. A version that was published is still in the version list and can be restored, but an unpublished draft body is gone.

Paramètres

idOrSlugstringObligatoire: The template whose design is being replaced, by tpl_ id or slug.
body.starterstring: A starter slug from listStarters. Mutually exclusive with fromTemplateId.
body.fromTemplateIdstring: Another template in this workspace to borrow the design from, by id or slug. Mutually exclusive with starter.
body.expectedVersionnumber: The head version you read before replacing. A mismatch is a 409 version_conflict and nothing is written.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateDetailResource with the unchanged metadata and latest set to the version this call wrote into, carrying the new document or html.

Exemple

const current = await openemail.templates.get('order-shipped') const replaced = await openemail.templates.replaceContent('order-shipped', {    starter: 'order-shipped',    expectedVersion: current.latestVersion}) console.log(replaced.latest.version, replaced.latest.state) await openemail.templates.publish('order-shipped')

Remarques

The new body brings the source's slots and props with it, replacing the target's declarations entirely. A send that passed the old props may start failing with unknown_template_prop, so read the response before publishing.
A template cannot replace its own design: that is a 422 invalid_template on fromTemplateId.
Not retried by the SDK. With expectedVersion set, a repeat after a lost response is a 409 if the first attempt landed.

Aussi disponible dans

API: POST /templates/{id}/content
CLI: openemail templates replace-content

`templates.delete()`

Delete a template and every version

templates:write

Signature

delete(idOrSlug: string, options?: RequestScope): Promise<DeletedTemplateResource>

Permanently removes the template and all of its versions. There is no undo. Mail already accepted is unaffected, because each send stores the body it rendered, but any integration still sending against this id or slug starts receiving 404s.

If you might need the template again, archive it with update(idOrSlug, { status: 'archived' }) instead. The response is a tombstone rather than an empty body, so a log line can record exactly what was removed.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

DeletedTemplateResource: { object: 'template', id, deleted: true }, where id is always the tpl_ id, even when you passed a slug.

Exemple

const deleted = await openemail.templates.delete('order-shipped') console.log(deleted.id, deleted.deleted)

Remarques

Deleting frees both the name and the slug. A template created later with the same slug gets a new tpl_ id.
Archived templates still count towards the 200 template limit, so deleting is the only way to make room.
Refused with a 409 template_in_use while a scheduled or queued broadcast still names the template. Cancel the broadcast or wait until it starts sending.
Not retried by the SDK. Repeating a delete that already succeeded is a 404.

Aussi disponible dans

API: DELETE /templates/{id}
CLI: openemail templates delete

`templates.listVersions()`

List one page of a template's versions, newest first

templates:readParcourt les résultats page par page

Signature

listVersions(idOrSlug: string, options?: ListOptions): Promise<Page<TemplateVersionResource>>

Returns one page of a template's versions, newest first. Every publish adds a version, so a template edited for a long time holds many: follow nextCursor while hasMore is true to reach version 1, or let listAllVersions and iterateVersions do that walk. At most one version is a draft and it is always the highest number. Every version below it has been published, and the highest published version is the one unpinned sends resolve to.

Bodies are left out, so document and html are absent on every row. What each version declares (subject, slots and props) is present, which makes this the call for checking what pinning a version on send would commit you to.

Pages are keyset on the version number, so a version deleted while you walk never breaks the walk: the next page starts at the first version below the cursor.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.limitnumber: Versions per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor of the previous page, passed back as it came. It is opaque, so never build one yourself.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

Page<TemplateVersionResource> with items, hasMore and nextCursor. Each item has id (a tplv_ id), templateId, version, state, engine, subject, slots, props, publishedAt and createdAt.

Exemple

const page = await openemail.templates.listVersions('order-shipped', { limit: 10 }) const live = page.items.find((version) => version.state === 'published') console.log(live?.version, live?.props.filter((prop) => prop.required).map((prop) => prop.key))console.log(page.hasMore, page.nextCursor)

Remarques

An empty first page is impossible for an existing template, since version 1 is created with it. No published row anywhere in the walk means the template cannot be sent yet.
get returns only the head body. getVersion returns any one version's body, and passing the same number as version to preview renders it.
A cursor this list did not hand out is a 400 invalid_cursor, and a template id or slug that names nothing is a 404.

Aussi disponible dans

API: GET /templates/{id}/versions
CLI: openemail templates list-versions

`templates.listAllVersions()`

Collect every version of a template into one array

templates:readParcourt les résultats page par page

Signature

listAllVersions(idOrSlug: string, options?: ListOptions): Promise<Array<TemplateVersionResource>>

Walks every page of a template's versions and resolves with all of them, newest first. It follows nextCursor until hasMore is false, one request per page.

A version published during the walk is newer than its first page and is not included. A version deleted during the walk is simply missing from the result.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.limitnumber: Page size for each request, 1 to 100. The server defaults to 25.
options.cursorstring: Starts the walk from this cursor instead of the newest version.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client API key for every page of this walk.

Retourne

Array<TemplateVersionResource> holding every version of the template, newest first.

Exemple

const versions = await openemail.templates.listAllVersions('order-shipped', { limit: 100 }) const published = versions.filter((version) => version.state === 'published') console.log(`${published.length} of ${versions.length} versions were published`)

Remarques

If any page fails the promise rejects and the versions already fetched are discarded.
Use iterateVersions to stop early, for example at the first published version.

Aussi disponible dans

API: GET /templates/{id}/versions

`templates.iterateVersions()`

Stream a template's versions one at a time, newest first

templates:readParcourt les résultats page par page

Signature

iterateVersions(idOrSlug: string, options?: ListOptions): AsyncGenerator<TemplateVersionResource, void, undefined>

Returns an async generator over a template's versions that yields them individually and fetches the next page only when the current one is drained. Nothing is requested until you consume it, and breaking out of the loop stops further requests.

The walk ends when hasMore is false, when a page comes back empty, or when the server repeats a cursor.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.limitnumber: Page size per request, 1 to 100. The server defaults to 25.
options.cursorstring: Starts the walk from this cursor instead of the newest version.
options.signalAbortSignal: Cancels the request in flight and ends the iteration.
options.apiKeystring: Overrides the client API key for every page of this walk.

Retourne

AsyncGenerator<TemplateVersionResource, void, undefined> yielding one version per step.

Exemple

for await (const version of openemail.templates.iterateVersions('order-shipped')) {    if (version.state === 'published') {        console.log('live is version', version.version)        break    }}

Remarques

An aborted options.signal rejects the pending page request, which throws out of the for await loop.

Aussi disponible dans

API: GET /templates/{id}/versions

`templates.getVersion()`

Read one version of a template, body included

templates:read

Signature

getVersion(idOrSlug: string, version: number, options?: RequestScope): Promise<TemplateVersionResource>

One frozen revision with its body. document carries the block tree for the blocks engine and html carries the submitted markup for the html engine, alongside the subject, slots and props that were declared at the time.

This is what listVersions leaves out. It is the only way to read an old version without changing anything: restoreVersion also shows you the body, but it moves the head to get there, so reading version 3 used to cost you your draft.

Reach for it to diff a regression against the revision that worked, to lift a block out of a design you have since replaced, or to record what a campaign actually said.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
versionnumberObligatoire: The version number to read, as listVersions reports it. Not a tplv_ id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateVersionResource with document and html populated, plus id, templateId, version, state, engine, subject, slots, props, publishedAt and createdAt. Only one of document and html holds anything; the other is null, and which it is follows engine.

Exemple

const live = await openemail.templates.getVersion('order-shipped', 3) const head = await openemail.templates.get('order-shipped') if (live.subject !== head.latest.subject) {    console.log(`subject changed since v3: ${live.subject} -> ${head.latest.subject}`)} await openemail.templates.update('order-shipped', { engine: live.engine, subject: live.subject, document: live.document ?? undefined, html: live.html ?? undefined })

Remarques

A number nobody published, or one that was deleted, is a 404 template_version_not_found. Numbers are never reused, so a deleted one stays gone.
html is the markup exactly as it was submitted, not what went out: sanitising happens at publish, against the compiled copy.
Nothing is rendered here. Pass the same number as version to preview to see it with values substituted.
Reading a version does not touch the draft. restoreVersion is still the call that brings an old body back.

Aussi disponible dans

API: GET /templates/{id}/versions/{version}
CLI: openemail templates get-version

`templates.publish()`

Publish the draft so sends resolve to it

templates:write

Signature

publish(idOrSlug: string, options?: RequestScope): Promise<TemplateVersionResource>

Freezes the head version and makes it the one unpinned sends resolve to. Compiling happens here: a blocks tree is rendered through react-email and html markup is sanitised, so a body that does not render fails with 422 invalid_template for the person publishing rather than for a recipient. Nothing is published when that happens.

The call is idempotent. If the head is already the published version it comes back unchanged, so a deploy script can publish on every run. Publishing also sets the template's status to active, which reactivates an archived template.

Only the head can be published, and there is no call to republish an older version. To keep production on an earlier version while a new one is prepared, pin that version on send. The response is the published version with the updated parent attached as template.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateVersionResource for the head with state: 'published' and publishedAt set, without document or html, plus template, the parent TemplateResource showing the new publishedVersion and status.

Exemple

const published = await openemail.templates.publish('order-shipped') console.log(published.version, published.publishedAt)console.log(published.template?.publishedVersion, published.template?.status)

Remarques

The SDK retries this call on network errors and retryable statuses, which is safe because publishing twice lands in the same place.
The server answers 201 even when nothing changed.
Sends that pin an earlier version are unaffected. Only unpinned sends move to the new version.
An html placeholder used inside an attribute with kind text fails here with param set to props.<key>.

Aussi disponible dans

API: POST /templates/{id}/versions
CLI: openemail templates publish

`templates.restoreVersion()`

Bring an older version's body back as the draft

templates:write

Signature

restoreVersion(idOrSlug: string, version: number, body?: TemplateRestoreInput, options?: RequestScope): Promise<TemplateRestoredResource>

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

Where it lands follows the usual rule. A published head mints version N+1 as a draft; a draft head is overwritten, so restoring twice does not pile up versions. Live sends do not move until you publish, so a restore is reversible until then: restore something else, or publish to commit.

Restoring the head itself is a 422, because there is nothing to bring back. An unknown version is a 404. expectedVersion makes the call safe against a concurrent editor, the same as on update.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
versionnumberObligatoire: The version whose body you want back, as listVersions reports it.
body.expectedVersionnumber: The head version you read before restoring. A mismatch is a 409 version_conflict and nothing is written.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateRestoredResource: a TemplateDetailResource whose latest is the version this call wrote, plus restoredFrom, the version number it was copied from.

Exemple

const versions = await openemail.templates.listAllVersions('order-shipped') const good = versions.find((version) => version.version === 2) const restored = await openemail.templates.restoreVersion('order-shipped', good!.version) console.log(restored.restoredFrom, restored.latest.version, restored.latest.state) await openemail.templates.publish('order-shipped')

Remarques

It does not publish. Until you call publish, sends keep resolving whatever was live before.
The restored body brings the old version's slots and props with it, so a send passing newer props may start failing with unknown_template_prop.
Restoring the current head is a 422 invalid_template, not a no-op.
Not retried by the SDK, because a repeat can mint a second version.

Aussi disponible dans

API: POST /templates/{id}/versions/{version}/restore
CLI: openemail templates restore-version

`templates.deleteVersion()`

Delete one version of a template

templates:write

Signature

deleteVersion(idOrSlug: string, version: number, options?: RequestScope): Promise<DeletedTemplateVersionResource>

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

Three versions cannot be deleted, and each refusal is a 422 rather than a silent success: the LIVE version, because sends resolve it; the HEAD, because that is the one 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 at all, so delete the template instead.

Everything else is fair game. Mail already sent from a deleted version is untouched, since a send stores the body it rendered, but a send that pins a deleted version starts failing with template_version_not_found.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
versionnumberObligatoire: The version number to delete, as listVersions reports it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

DeletedTemplateVersionResource: { object: 'template_version', templateId, version, deleted: true }.

Exemple

const versions = await openemail.templates.listAllVersions('order-shipped') const stale = versions.filter((version) => version.state === 'published' && version.publishedAt === null) for (const version of versions.slice(3)) {    await openemail.templates.deleteVersion('order-shipped', version.version)} console.log(stale.length)

Remarques

The live version is a 422 template_version_not_deletable. Publish another version first, then delete it.
The head is refused for the same code. Call restoreVersion with an older version, which makes a new head, and the old head becomes deletable.
Version numbers are never reused: deleting version 3 does not free the number.
Not retried by the SDK. Repeating a delete that succeeded is a 404.

Aussi disponible dans

API: DELETE /templates/{id}/versions/{version}
CLI: openemail templates delete-version

`templates.listStarters()`

List the built-in starter designs

templates:read

Signature

listStarters(options?: RequestScope): Promise<Array<TemplateStarterResource>>

The starter designs the web editor offers, as a plain array. A starter is a ready-made block document with a subject and its declared slots and props, and it is the same catalogue the console shows, so an integration and a person building a template by hand start from the same place.

Bodies are left out here. slug is the handle to pass as starter to create or replaceContent, and getStarter returns one in full with its block tree and a rendered preview.

Starters are static: they are part of the product rather than workspace data, so this answer is the same for every key and changes only when a release adds one.

Paramètres

options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

Array<TemplateStarterResource>, each with slug, name, description, category (account, commerce, notify or marketing), subject, and the slots and props it declares.

Exemple

const starters = await openemail.templates.listStarters() for (const starter of starters) {    console.log(starter.category, starter.slug, starter.props.map((prop) => prop.key))}

Remarques

Not paginated, and there is no cursor. The catalogue is small.
A starter's props are what the template gets on creation. They are yours to change afterwards with update.

Aussi disponible dans

API: GET /templates/starters
CLI: openemail templates list-starters

`templates.getStarter()`

Retrieve one starter design, body and preview included

templates:read

Signature

getStarter(slug: string, options?: RequestScope): Promise<TemplateStarterDetailResource>

One starter in full: everything the list carries, plus document, the block tree itself, and preview, the starter rendered to HTML with each undefaulted prop left visible as {{key}}.

The preview is what the console shows in its starter picker, so a client can display the same thing without rendering anything itself. The document is there so you can seed a template from a starter and edit the tree before creating it, rather than creating from the starter and patching afterwards.

An unknown slug is a 404. Pass the slug exactly as listStarters reports it.

Paramètres

slugstringObligatoire: A starter slug from listStarters, such as welcome.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateStarterDetailResource: the starter's metadata with document (the block tree, ready to send as document on create) and preview (rendered HTML).

Exemple

const starter = await openemail.templates.getStarter('welcome') const created = await openemail.templates.create({    name: 'Welcome',    subject: starter.subject,    document: starter.document,    publish: true}) console.log(created.slug, created.publishedVersion)

Remarques

Passing starter: 'welcome' to create does the same seeding server side, and is one call instead of two.
The preview is rendered once per process and cached, so it costs nothing to ask for it repeatedly.

Aussi disponible dans

API: GET /templates/starters/{slug}
CLI: openemail templates get-starter

`templates.listFonts()`

List the web fonts a template can load

templates:read

Signature

listFonts(options?: RequestScope): Promise<Array<TemplateFontResource>>

Every web font a template may load, as a plain array, in the order the web editor offers them. Each row names a family, the full CSS stack to write, the fallback a mail client shows when it cannot load the font, the weight range the file covers, and the url the file is served from.

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 font loaded from anywhere else would tell whoever runs that host when the message was read, whatever the workspace has open tracking set to. A template whose webFont.url is not the one listed here for its family is refused with 422 invalid_template.

Fonts are static: they are part of the product rather than workspace data, so this answer is the same for every key and changes only when a release adds one.

Paramètres

options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

Array<TemplateFontResource>, each { object: 'template_font', family, fallback, stack, weight, format, url }, with format always woff2.

Exemple

const fonts = await openemail.templates.listFonts() const inter = fonts.find((font) => font.family === 'Inter') console.log(inter?.stack, inter?.url)

Remarques

Not paginated, and there is no cursor. The catalogue is small.
One template may load at most 8 web fonts. A family that is not listed still renders: leave webFont out and it falls back to fallbackFontFamily, which is what Gmail and Outlook on Windows do with every web font anyway.

Aussi disponible dans

API: GET /templates/fonts
CLI: openemail templates list-fonts

`templates.render()`

Render a body that is not stored anywhere

templates:read

Signature

render(body: TemplateRenderInput, options?: RequestScope): Promise<TemplateRenderResource>

Compiles and renders content you pass in, without creating a template or touching one. This is what the web editor calls while somebody types, and it is the call for checking a design in CI before it becomes a template.

Everything create accepts as content is accepted here: document for the blocks engine, html for the html engine, plus subject, slots and props. values.props and values.slots fill the placeholders; anything left unfilled is rendered blank and reported in warnings, exactly as preview does for a stored template.

mark: true leaves every placeholder visible as {{key}} instead of substituting it, which is how an editor shows an author what is a variable.

Paramètres

body.engineTemplateEngine: Defaults to html when html is sent and blocks otherwise.
body.subjectstring: The subject to render, at most 998 characters.
body.documentTemplateDocument: The blocks body for the blocks engine, validated in full: body plus preview, tailwind, fonts and style.
body.htmlstring: The markup for the html engine, at most 1,000,000 characters.
body.slotsArray<Partial<TemplateSlot> & { key: string }>: The slots this body declares.
body.propsArray<Partial<TemplateProp> & { key: string }>: The props this body declares.
body.values.propsRecord<string, unknown>: Values for the declared props. A missing one renders blank and is reported.
body.values.slotsRecord<string, unknown>: Values for the declared slots, overriding their defaults.
body.markboolean: Leaves placeholders as {{key}} rather than substituting them.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateRenderResource with subject, html, text and warnings, each warning { code: 'unfilled_placeholder', key }. Nothing is stored and nothing is sent.

Exemple

const rendered = await openemail.templates.render({    subject: 'Order {{orderId}} is on its way',    html: '<p>Hello {{customer}}, {{orderId}} left the warehouse.</p>',    props: [{ key: 'orderId', kind: 'text', required: true }, { key: 'customer', kind: 'text' }],    values: { props: { orderId: 'A-3311', customer: 'Ada' } }}) console.log(rendered.subject)console.log(rendered.warnings.length)

Remarques

Needs only templates:read, because nothing is written. A body that does not compile is a 422 invalid_template naming the offending path.
Lenient like preview: a required prop with no value is a warning here and a refusal on a send.
Retried by the SDK on network errors, since rendering has no side effects.

Aussi disponible dans

API: POST /templates/render
CLI: openemail templates render

`templates.preview()`

Render a template without sending it

templates:read

Signature

preview(idOrSlug: string, body?: TemplatePreviewInput, options?: RequestScope): Promise<TemplatePreviewResource>

Renders a version with the values you pass and returns the subject, HTML and plain text a send with the same values would produce. Nothing is sent or recorded. Point CI at it so a broken template is caught by a test rather than by a customer.

It renders the published version unless version names another one, and unlike send it can render a draft, which is compiled on the fly. A template with nothing published needs an explicit version, otherwise the call is a 422 template_not_published. Required props are relaxed here: a missing one renders its default or an empty string, and every placeholder that ends up blank is listed in warnings as unfilled_placeholder.

The other value checks still apply. A key the version does not declare is a 422 unknown_template_prop or unknown_template_slot, and a value that is not a string, number or boolean is a 422 invalid_template_prop. Values of kind url or image are parsed, and anything outside http, https, mailto, tel and cid renders as #.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
body.versionnumber: Version to render, drafts included. Defaults to the published version.
body.propsRecord<string, unknown>: Values for declared props, keyed by prop key. Strings, numbers and booleans only.
body.slotsRecord<string, unknown>: Overrides for slot defaults, keyed by slot key.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplatePreviewResource with templateId, the resolved version, the filled subject, html and text, and warnings as an array of { code, key }.

Exemple

const preview = await openemail.templates.preview('order-shipped', {    props: { orderId: 'AC-4192', customer: 'Ada', trackingUrl: 'https://track.example.com/AC-4192' }}) if (preview.warnings.length > 0) {    throw new Error(`Unfilled: ${preview.warnings.map((warning) => warning.key).join(', ')}`)} console.log(preview.version, preview.subject)

Remarques

Needs only templates:read, so a CI key can preview without being able to edit or send.
Assert that warnings is empty. send refuses a missing required prop that preview only reports.
A version that does not exist is a 404. Treat an unrecognised warning code as a warning too.
The SDK retries it on network errors and retryable statuses, since rendering has no side effects.

Aussi disponible dans

API: POST /templates/{id}/preview
CLI: openemail templates preview

`templates.getAnalytics()`

How one template has performed

templates:read

Signature

getAnalytics(idOrSlug: string, options?: TemplateAnalyticsOptions): Promise<TemplateAnalyticsResource>

The engagement report the console shows on a template: how many messages it rendered in the window, how many of those were tracked, how many were opened and clicked, and the same numbers broken down by day, by source and by version.

Rates are computed against what was TRACKED, not against everything sent, because a message sent with tracking off can never report an open and counting it would quietly lower every rate. trackedForOpens and trackedForClicks are the denominators, and they are in the response so you can recompute anything yourself.

lifetime ignores the window: it is every live send this template has ever made, the test sends counted separately, and the first and last time it sent. recent previews the twelve newest sends in the window with their own open and click counts, which is the fastest way to see whether a template that was just published is behaving. It is a preview, not the list: listSends returns every send in the window, a page at a time.

Only live sends are in the windowed figures. A message sent with a test key counts in lifetime.testSends and nowhere else.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.daysnumber: How far back to look, 1 to 365. Defaults to 30. The window starts at the beginning of that day and ends now.
options.minutesnumber: The window in minutes, which wins over days. For the last hour of a send in flight.
options.grainTrackingGrain: How wide one byDay bucket is: day, hour or minute. The bucket keys change shape with it.
options.offsetMinutesnumber: The reader's UTC offset in minutes, -840 to 840, so days are bucketed in their own timezone.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateAnalyticsResource with sends, matched, trackedForOpens, trackedForClicks, opened, clicked, openRate, clickRate, totalOpens, totalClicks, the bySource, byDay and byVersion breakdowns, recent (a preview of the twelve newest sends, with every one of them a page at a time through listSends) and lifetime.

Exemple

const analytics = await openemail.templates.getAnalytics('order-shipped', { days: 7, grain: 'day' }) console.log(analytics.sends, analytics.openRate, analytics.clickRate) for (const version of analytics.byVersion) {    console.log(version.version, version.sends, version.opened)}

Remarques

openRate and clickRate are percentages to one decimal place, and are 0 when nothing was tracked rather than null.
matched is how many renders were paired with a tracked message. A gap between sends and matched is sends that carried no tracking at all, not lost data.
A template that has never sent answers 200 with zeroes, not a 404. The 404 is for a template that does not exist.
Retried by the SDK on network errors, since it only reads.

Aussi disponible dans

API: GET /templates/{id}/analytics
CLI: openemail templates get-analytics

`templates.listSends()`

The individual messages a template sent

templates:read

Signature

listSends(idOrSlug: string, options?: TemplateSendListOptions): Promise<TemplateSendsResource>

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 numbers getAnalytics reports, and the place to answer "did this person get it".

Paging here is by page number rather than by cursor, because the console shows a table with a total, and total is the count matching the filters rather than the size of the page. Pages are 25 rows by default and at most 100.

The filters narrow by window (days or minutes), by version, by source, and by engagement: opened, clicked and tracked each take a boolean. search matches the subject and the recipient addresses. A row whose message carried no tracking reports matched: false and zero counts, which is not the same as nobody opening it.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
options.pagenumber: Which page, from 1. Defaults to 1.
options.pageSizenumber: Rows per page, 1 to 100. Defaults to 25.
options.searchstring: Matches the subject that went out and the recipient addresses.
options.sourcestring: Only sends from one source, such as api or console.
options.versionnumber: Only sends that rendered this version number.
options.openedboolean: True for sends with at least one counted open, false for none.
options.clickedboolean: True for sends with at least one counted click, false for none.
options.trackedboolean: True for sends that carried tracking at all, false for the ones that could never report.
options.daysnumber: How far back to look, 1 to 365. Defaults to 30.
options.minutesnumber: The window in minutes, which wins over days.
options.grainTrackingGrain: Only floors the start of the window, so this list can cover the same window as getAnalytics.
options.offsetMinutesnumber: The reader's UTC offset in minutes, -840 to 840.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

TemplateSendsResource with items, total (matching rows, not page size), page and pageSize. Each row has id, version, source, subject, createdAt, recipients, matched, opens, clicks, openCount and clickCount.

Exemple

const sends = await openemail.templates.listSends('order-shipped', {    days: 7,    opened: false,    tracked: true,    pageSize: 50}) console.log(sends.total, sends.items.length) for (const send of sends.items) {    console.log(send.createdAt, send.recipients.join(', '), send.openCount)}

Remarques

opens and clicks say whether the message ASKED to be tracked; openCount and clickCount say what happened.
Only live sends are listed. Test-key sends are counted in getAnalytics().lifetime.testSends and appear nowhere here.
Page numbers are not stable while mail is going out, since a new send pushes rows down. Narrow the window rather than paging deep.

Aussi disponible dans

API: GET /templates/{id}/sends
CLI: openemail templates list-sends

`templates.send()`

Send an email rendered from a template

templates:writeemails:send

Signature

send(idOrSlug: string, body: TemplateSend, options?: SendScope): Promise<SentTemplateEmailResource>

Resolves the published version, or the one version pins, fills its placeholders from props and slots, and queues the message. Values are checked strictly here. An undeclared key is a 422 unknown_template_prop or unknown_template_slot, a missing required prop is a 422 missing_template_prop, and a value that is not a string, number or boolean is a 422 invalid_template_prop, each with param set to template.props.<key>. A template with nothing published, or a pinned version that is still a draft, is a 422 template_not_published. No mail leaves when any of these fail.

Pin version in production code. Without it every send resolves whatever is published at that moment, which changes the morning somebody publishes a rewrite. subject replaces the version's subject for this message only and is used exactly as written, with no placeholder filling. scheduledAt takes a Date, an ISO 8601 instant or an ISO 8601 duration such as PT30M, up to 365 days out, and cannot be combined with a non zero cancellableForSeconds.

The SDK attaches an Idempotency-Key generated once per call and reuses it on that call's retries, so a retry replays the original message instead of sending a second one. Pass options.idempotencyKey to deduplicate across processes and restarts, and derive it from what caused the send, never from a clock. A replay resolves with replayed: true and the original message, while reusing a key with a different body is a 422 idempotency_key_reuse.

Paramètres

idOrSlugstringObligatoire: A tpl_ id or the template's slug.
body.fromRecipientInputObligatoire: Sender as address, Name <address> or { email, name }. The key must be allowed to send as it, otherwise 403 from_address_forbidden.
body.toRecipientInput | Array<RecipientInput>Obligatoire: 1 to 50 recipients. The SDK wraps a single value in an array.
body.ccRecipientInput | Array<RecipientInput>: Up to 50 copied recipients.
body.bccRecipientInput | Array<RecipientInput>: Up to 50 blind copied recipients.
body.replyToRecipientInput: Sets the Reply-To header.
body.versionnumber: Published version to send. Defaults to the currently published one.
body.propsRecord<string, unknown>: Values for the declared props: strings, numbers or booleans, keyed by prop key.
body.slotsRecord<string, unknown>: Overrides for slot defaults, keyed by slot key.
body.subjectstring: Replaces the version's subject for this message, sent verbatim, at most 998 characters.
body.scheduledAtDate | string: 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.
body.cancellableForSecondsnumber: Holds the message 0 to 900 seconds so it can still be cancelled. Defaults to 0 and is refused alongside scheduledAt.
body.trackingTrackingRequest: Per message opens and clicks switches for open and click tracking.
body.tagsRecord<string, string>: Your own labels for the send, keys up to 64 and values up to 256 characters.
body.translateSendTranslateOptions: Translates the rendered message into to before sending, with optional from, includeOriginal (default true) and subject (default true).
options.idempotencyKeystring: Your own key in place of the generated one: 1 to 255 characters of letters, digits, _, ., : or -.
options.signalAbortSignal: Cancels the request and any pending retry.
options.apiKeystring: Overrides the client API key for this call only.

Retourne

SentTemplateEmailResource: the EmailResource fields such as id, status, mode, from, subject, messageId, threadId, scheduledAt, cancellableUntil, tags and createdAt, plus replayed and template, which holds the id you called with and the version that went out.

Exemple

const sent = await openemail.templates.send('order-shipped', {    from: { email: '[email protected]', name: 'Acme Dispatch' },    to: '[email protected]',    version: 5,    props: { orderId: 'AC-4192', customer: 'Ada', trackingUrl: 'https://track.example.com/AC-4192' }}, {    idempotencyKey: 'order-shipped:AC-4192'}) console.log(sent.id, sent.status, sent.template.version, sent.replayed)

Remarques

A from on a domain that cannot sign mail yet is refused with 409 domain_not_sendable, the same as emails.send.
Needs both templates:write and emails:send. A key that may send its own bodies still cannot send a stored template without the first.
The replay check hashes the request together with the version it resolved to. An unpinned retry that lands after somebody publishes a new version is refused with idempotency_key_reuse rather than replayed, so pin version when you rely on replays.
template.id echoes the argument you passed, so it is the slug when you sent by slug. Call get if you need the tpl_ id.
An archived template is a 422 template_archived. An unknown template is a 404 resource_not_found, while a pinned version that does not exist is a 422 template_version_not_found with param set to template.version.

Aussi disponible dans

API: POST /templates/{id}/send
CLI: openemail templates send

`templates.listImages()`

List one page of template images

templates:readParcourt les résultats page par page

Signature

listImages(options?: ListOptions): Promise<Page<TemplateImageResource>>

Resolves one page of the images uploaded for templates, newest first: the library the template editor offers when you add an image. listAllImages collects every page and iterateImages walks them lazily.

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.

Paramètres

options.limitnumber: Page size, from 1 to 120. The server defaults to 24.
options.cursorstring: The nextCursor of the previous page. Leave it out for the first page.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

Page<TemplateImageResource> with items, hasMore and nextCursor. Each item has id, url and size.

Exemple

const page = await openemail.templates.listImages({ limit: 10 }) console.log(page.items.map((image) => image.url))

Remarques

Needs templates:read.

Aussi disponible dans

API: GET /templates/images
CLI: openemail templates list-images

`templates.listAllImages()`

Collect every template image into one array

templates:readParcourt les résultats page par page

Signature

listAllImages(options?: ListOptions): Promise<Array<TemplateImageResource>>

Walks every page of listImages and resolves with every template image, newest first. One request per page.

Paramètres

options.limitnumber: Page size for each request, from 1 to 120. The server defaults to 24.
options.cursorstring: Starts the walk after this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Retourne

Array<TemplateImageResource> holding every image.

Exemple

const images = await openemail.templates.listAllImages() console.log(images.length)

Remarques

If any page fails the promise rejects and the images already fetched are discarded.

Aussi disponible dans

API: GET /templates/images

`templates.iterateImages()`

Stream template images one at a time

templates:readParcourt les résultats page par page

Signature

iterateImages(options?: ListOptions): AsyncGenerator<TemplateImageResource, void, undefined>

Returns an async generator that yields one template image at a time, newest first, and requests the next page only once the current one is drained.

Paramètres

options.limitnumber: Page size for each request, from 1 to 120. The server defaults to 24.
options.cursorstring: Starts the walk after this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Retourne

AsyncGenerator<TemplateImageResource, void, undefined> yielding one image per step.

Exemple

for await (const image of openemail.templates.iterateImages()) {    console.log(image.id, image.url)}

Remarques

The generator is lazy, so an abandoned loop costs only the pages you consumed.

Aussi disponible dans

API: GET /templates/images

`templates.uploadImage()`

Upload an image for templates

templates:write

Signature

uploadImage(data: RawBody, options?: TemplateImageOptions): Promise<UploadedTemplateImageResource>

Sends the image bytes as the request body and resolves with its public url, ready to put in a template. It is the upload of the template editor.

PNG, JPEG, WebP, GIF or SVG, up to 5 MB, fitted into 1200 by 1800 pixels and stored in a form every mail client shows. The type is read from options.contentType, or from a Blob's own type when that is left out, and without either the server refuses the bytes with 422 invalid_image.

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.

Paramètres

dataRawBodyObligatoire: The image: a Blob, ArrayBuffer or Uint8Array.
options.contentTypeTemplateImageType: image/png, image/jpeg, image/webp, image/gif or image/svg+xml. Required unless data is a Blob with a type.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

UploadedTemplateImageResource with id, url, size, width and height.

Exemple

const file = Bun.file('hero.png') const image = await openemail.templates.uploadImage(await file.arrayBuffer(), { contentType: 'image/png' }) console.log(image.url, image.width, image.height)

Remarques

The SDK does not retry an upload, because a second one stores a second copy.
An image of another type, one over 5 MB, or one that cannot be read is refused with 422 invalid_image. A busy image service answers 503 image_busy and a failed save 502 image_not_stored.

Aussi disponible dans

API: POST /templates/images
CLI: openemail templates upload-image

`templates.design()`

Design a new template from a brief

templates:write

Signature

design(body: TemplateDesignInput, options?: RequestScope): Promise<DesignedTemplateResource>

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. It uses every block the editor has, with a palette, type and spacing, and the result opens in the visual editor fully editable.

Put everything the design must hold in brief: what it is for, the sections in order, the words, the colours and fonts, and which values change per recipient. starter builds on a starter design, and imageFileIds places up to ten uploaded or received images. It spends one AI action and can take up to a minute.

Paramètres

body.namestringObligatoire: A short name for the template. When the name is taken, a free one is chosen and returned.
body.briefstringObligatoire: Everything the design must hold and look like, up to 8,000 characters.
body.descriptionstring: One line about what it is for.
body.starterstring: The slug of a starter design to build on, from listStarters.
body.imageFileIdsArray<string>: Up to ten file ids of images to place in the design.
body.publishboolean: Publish it at once so it can be sent. Defaults to false.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

DesignedTemplateResource: the template, plus design with the subject, the notes on what was adjusted and the imageProblems.

Exemple

const template = await openemail.templates.design({    name: 'Spring launch',    brief: 'A launch email for our spring collection: a hero image, three product cards and a button to the shop. Green and cream, friendly tone.'}) console.log(template.id, template.design.subject)

Remarques

The SDK does not retry it, because a second call designs and saves a second template.
A design that cannot be made valid is a 422 invalid_template, a server with no model a 409 ai_not_configured, and a workspace out of AI actions a 429 ai_quota_exceeded.
An image id the key cannot reach is left out and named in design.imageProblems.

Aussi disponible dans

API: POST /templates/design
CLI: openemail templates design

`templates.redesign()`

Change a template’s design from instructions

templates:write

Signature

redesign(idOrSlug: string, body: TemplateRedesignInput, options?: RequestScope): Promise<DesignedTemplateResource>

A designer applies written instructions to a block template and leaves everything else alone: restyle it, change colours, fonts or spacing, rewrite or translate its copy, add, move or remove sections, swap an image. The change lands in the draft, so live sends keep the published version until you publish.

A raw HTML template cannot be redesigned and is refused with 422 invalid_template. It spends one AI action.

Paramètres

idOrSlugstringObligatoire: The template's id or slug.
body.instructionsstringObligatoire: What to change, with every detail: the words, colours and which section. Up to 8,000 characters.
body.imageFileIdsArray<string>: Up to ten file ids of images to use.
body.expectedVersionnumber: The version you based the change on. A newer one is refused with 409 version_conflict.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

DesignedTemplateResource: the template, plus design with changes (blocks edited, added and removed), draftVersion, the subject, notes and imageProblems.

Exemple

const template = await openemail.templates.redesign('spring-launch', {    instructions: 'Make the button orange and translate the copy into Spanish.'}) console.log(template.design.changes, template.design.draftVersion)

Remarques

The SDK does not retry it, because each call is a fresh design pass.
The same errors as design, plus 404 for a template that does not exist.

Aussi disponible dans

API: POST /templates/{id}/redesign
CLI: openemail templates redesign