> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Send a test email
> Sends the template, rendered as the preview renders it, to the
signed-in admin, and never to another address: the sample data comes
from a real customer's records. Takes the same body as the preview.
## OpenAPI
````yaml /api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/test_email
openapi: 3.0.3
info:
title: Admin API
contact:
name: Spree Commerce
url: https://spreecommerce.org
email: hello@spreecommerce.org
description: >
Spree Admin API v3 - Administrative API for managing products, orders, and
store settings.
## Authentication
The Admin API requires a secret API key passed in the `x-spree-api-key`
header.
Secret API keys can be generated in the Spree admin dashboard.
## Response Format
All responses are JSON. List endpoints return paginated responses with
`data` and `meta` keys.
Single resource endpoints return a flat JSON object.
## Resource IDs
Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,
`variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,
request bodies, and Ransack filters all accept them directly.
## Error Handling
Errors return a consistent format:
```json
{
"error": {
"code": "validation_error",
"message": "Validation failed",
"details": { "name": ["can't be blank"] }
}
}
```
version: v3
servers:
- url: http://{defaultHost}
variables:
defaultHost:
default: localhost:3000
security: []
tags:
- name: Authentication
description: Admin user login, logout, token refresh, and current user profile
- name: Allowed Origins
description: CORS allowlist for storefront and admin client origins
- name: API Keys
description: Secret and publishable API keys
- name: Categories
description: >-
Hierarchical product categories — tree management, repositioning, and
product assignments
- name: Channels
description: >-
Sales channels, product publication across channels, and per-channel order
routing rules
- name: Custom Fields
description: >-
Custom field definitions for products, variants, customers, and other
resources
- name: Customer Groups
description: >-
Customer groups for segmenting customers (e.g. wholesale, VIP) used by
pricing and promotions
- name: Customers
description: Customer profiles, addresses, credit cards, and store credits
- name: Email Templates
description: >-
Customer email templates, the email layout and shared partials: drafts,
previews, publishing and history
- name: Exports
description: Async CSV exports of admin resources
- name: Files
description: Uploading the files that product media, imports, logos and documents use
- name: Fulfillments
description: Order fulfillments — shipments, fulfill, cancel, resume, split
- name: Gift Cards
description: Gift cards and gift card batches
- name: Imports
description: >-
Async CSV imports of admin resources, with per-row status and failed-row
retry
- name: Markets
description: >-
Markets — geographic groupings of countries used for pricing, tax, and
fulfillment rules
- name: Option Types
description: >-
Option types and option values used to build product variants (e.g. Size,
Color)
- name: Orders
description: Orders, order items, applied gift cards, and applied store credits
- name: Payment Methods
description: Configured payment providers and their available types
- name: Payments
description: Order payments — list, capture, void
- name: Pricing
description: >-
Prices and price lists for currency-, market-, and customer-group-specific
pricing
- name: Products
description: >-
Products, taxons/categories, product custom field values, and bulk product
operations
- name: Policies
description: The store's legal documents — terms of service, privacy, returns, shipping
- name: Reasons
description: >-
Merchant-owned vocabularies for why a return, claim, refund, cancellation
or tax exemption happened
- name: Promotions
description: Promotions, promotion rules, promotion actions, and coupon codes
- name: Refunds
description: Order refunds
- name: Settings
description: Store-level settings — store profile, tags, and configuration
- name: Staff
description: Admin users, roles, and invitations to the store
- name: Stock Locations
description: Warehouses and physical fulfillment locations
- name: Store Credits
description: Prepaid customer balances across all customers, and each balance's ledger
- name: Variants
description: >-
Product variants — the individual SKUs (size/color combinations) sold
under a product
- name: Webhooks
description: Webhook endpoints and webhook delivery history
paths:
/api/v3/admin/email_templates/{email_template_id}/test_email:
parameters:
- name: email_template_id
in: path
required: true
description: The template key with dots
schema:
type: string
post:
tags:
- Email Templates
summary: Send a test email
description: |
Sends the template, rendered as the preview renders it, to the
signed-in admin, and never to another address: the sample data comes
from a real customer's records. Takes the same body as the preview.
parameters:
- name: x-spree-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
description: Bearer token for admin authentication
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmailTemplatePreviewParams'
required: true
responses:
'202':
description: test email queued
content:
application/json:
example:
sent_to: luba@oberbrunner.com
schema:
type: object
properties:
sent_to:
type: string
required:
- sent_to
security:
- bearer_auth: []
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
source: >-
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: 'Thanks, {{ order.customer_name }}!',
})
- lang: bash
label: Spree CLI
source: >-
spree api post /email_templates/{email_template_id}/test_email -d
'{"body":"Thanks, {{
order.customer_name }}!"}'
components:
schemas:
EmailTemplatePreviewParams:
type: object
properties:
language:
type: string
description: >-
A language code, or `any` (the default) for the version every
language uses.
example: any
subject:
type: string
description: An unsaved subject, in place of the current one.
example: Your order {{ order.number }} is confirmed
nullable: true
body:
type: string
description: An unsaved body, in place of the current one.
example: >-
Thanks, {{ order.customer_name
}}!
record_id:
type: string
description: >-
The record to build sample data from; the store's latest matching
record otherwise.
example: or_m3Rp9wXz
email_key:
type: string
description: For the layout or a partial, the email to show it in.
example: spree.order_mailer.confirm_email
branding:
type: object
properties:
accent_color:
type: string
nullable: true
background_color:
type: string
nullable: true
card_color:
type: string
nullable: true
text_color:
type: string
nullable: true
heading_color:
type: string
nullable: true
font:
type: string
nullable: true
enum:
- inter
- system
- helvetica
- georgia
- roboto
- lato
- merriweather
description: >-
Unsaved colors and font to preview, named like the store's `email_*`
settings.
mailer_logo_signed_id:
type: string
description: >-
An unsaved email logo: the signed id of an uploaded image, or null
to preview without one.
nullable: true
securitySchemes:
bearer_auth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token for admin user authentication
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.