Send a test email

import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', jwtToken: 'eyJhbGciOi...', }) // Sent to the signed-in admin, so this needs a client created with `jwtToken`; // a secret key has no inbox and is refused. const { sent_to } = await client.emailTemplates.sendTest('spree.order_mailer.confirm_email', { body: '<mj-section><mj-column><mj-text>Thanks, {{ order.customer_name }}!</mj-text></mj-column></mj-section>', })

Authorizations

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Bearer token for admin authentication

Path Parameters

email_template_id

string

required

The template key with dots

Body

application/json

language

string

A language code, or any (the default) for the version every language uses.

Example:

"any"

subject

string | null

An unsaved subject, in place of the current one.

Example:

"Your order {{ order.number }} is confirmed"

body

string

An unsaved body, in place of the current one.

Example:

"<mj-section><mj-column><mj-text>Thanks, {{ order.customer_name }}!</mj-text></mj-column></mj-section>"

record_id

string

The record to build sample data from; the store's latest matching record otherwise.

Example:

"or_m3Rp9wXz"

email_key

string

For the layout or a partial, the email to show it in.

Example:

"spree.order_mailer.confirm_email"

branding

object

Unsaved colors and font to preview, named like the store's email_* settings.

Show child attributes

mailer_logo_signed_id

string | null

An unsaved email logo: the signed id of an uploaded image, or null to preview without one.

Response

202 - application/json

test email queued

sent_to

string

required

API basics

Endpoints

Authorizations

Headers

Path Parameters

Body

Response