> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview an email template

> The email for a sample buyer as it would be sent with what you send in place of what is saved: its `subject`, the whole page as `html`, its plain `text`, the `values` its variables had, and `problems` as Change an email template would say them. Nothing is saved and nothing is sent.

Needs the `emails.read` permission (Read Email Templates).



## OpenAPI

````yaml /api-reference/openapi.json post /stores/{storeId}/email-templates/{kind}/preview
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/email-templates/{kind}/preview:
    post:
      tags:
        - Email Templates
      summary: Preview an email template
      description: >-
        The email for a sample buyer as it would be sent with what you send in
        place of what is saved: its `subject`, the whole page as `html`, its
        plain `text`, the `values` its variables had, and `problems` as Change
        an email template would say them. Nothing is saved and nothing is sent.


        Needs the `emails.read` permission (Read Email Templates).
      operationId: emailTemplates.preview
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: kind
          in: path
          required: true
          description: >-
            Which email: `receipt`, `invoice`, `reward`, `panel-code`,
            `balance-code`, `site-code`, `ticket-reply`, `sub-renewal`,
            `sub-charged`, `sub-due`, `sub-declined`, `sub-paused`, `sub-ended`,
            `recovery-first`, `recovery-declined`, `recovery-second`,
            `winback-first`, `winback-second`.
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                html:
                  type: string
                  description: >-
                    HTML to preview in place of what is saved; null for the
                    original.
                css:
                  type: string
                  description: CSS to preview in place of what is saved.
                subject:
                  type: string
                  description: A subject to preview in place of what is saved.
                shared:
                  type: string
                  description: The CSS every email gets, in place of what is saved.
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      subject:
                        type: string
                      html:
                        type: string
                      text:
                        type: string
                      parts:
                        type: object
                        properties:
                          delivery:
                            type: string
                          buttons:
                            type: string
                          summary:
                            type: string
                          reply_note:
                            type: string
                      values:
                        type: object
                        properties:
                          store.name:
                            type: string
                          store.url:
                            type: string
                          store.panel_url:
                            type: string
                          buyer.email:
                            type: string
                          order.id:
                            type: string
                          order.paid_at:
                            type: string
                          order.total:
                            type: string
                          order.paid_with:
                            type: string
                          order.invoice_attached:
                            type: boolean
                          links.order:
                            type: string
                          links.review:
                            type: string
                          year:
                            type: string
                      problems:
                        type: object
                        properties:
                          html:
                            type:
                              - array
                              - object
                          css:
                            type:
                              - array
                              - object
                          subject:
                            type:
                              - array
                              - object
              example:
                success: true
                message: null
                code: null
                data:
                  subject: >-
                    Your Northwind Keys order is delivered
                    (a2855h0p1y4-71329ed4d95-1000427)
                  html: >-
                    <!doctype html>

                    <html lang="en">

                    <head>

                    <meta charset="utf-8">

                    <meta name="viewport"
                    content="width=device-width,initial-scale=1">

                    <meta name="color-scheme" content="light dark">

                    <meta name="supported-color-schemes" content="light dark">

                    <title>Northwind Keys
                    a2855h0p1y4-71329ed4d95-1000427</title>

                    <style>

                    :root{color-scheme:light dark;supported-color-schemes:light
                    dark}

                    @media only screen and (ma…
                  text: >-
                    Northwind Keys


                    Your order is delivered.


                    Lifetime License (Standard)
                      XXXX-7QK2-M9XD-4PLA-SAMPLE
                      Your instructions for this product are shown here.

                    View Your Order:
                    https://northwind.myshoply.gg/customer-panel/orders/a2855h0p1y4-71329ed4d95-1000427/


                    Leave a Review:
                    http://localhost:3002/checkout/a2855h0p1y4-71329ed4d95-1000427#review


                    ---------------------------------------…
                  parts:
                    delivery: "<div style=\"height:21px;line-height:21px;font-size:0;\">\_</div><div class=\"shp-ink\" style=\"font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,'Helvetica Neue',Arial,sans-serif;font-size:14px;line-height:21px;font-weight:600;color:#16191d;\">Lifetime License</div><div class=\"shp-muted\" style=\"font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,'Helvetica Neue',Arial,sans-serif…"
                    buttons: "<div style=\"height:18px;line-height:18px;font-size:0;\">\_</div><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\"><tr><td class=\"shp-stack\" valign=\"middle\"><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"button\"><tr><td class=\"shp-btn\" align=\"center\" valign=\"middle\" bgcolor=\"#16191d\" style=\"background-color:#16191d;border-radius:6px;padding:8px 13px;…"
                    summary: "<div style=\"height:22px;line-height:22px;font-size:0;\">\_</div><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" class=\"line\" style=\"width:100%;\"><tr><td class=\"shp-line\" style=\"border-top:1px solid #ebe8e3;height:0;font-size:0;line-height:0;\">\_</td></tr></table><div style=\"height:16px;line-height:16px;font-size:0;\">\_</div><table role=\"presentation\" width=\"100%\" …"
                    reply_note: >-
                      Replies to this address aren’t received. <a
                      href="https://example.com/support"
                      style="color:inherit;text-decoration:underline;">Contact
                      Northwind Keys</a>.
                  values:
                    store.name: Northwind Keys
                    store.url: https://northwind.myshoply.gg
                    store.panel_url: https://northwind.myshoply.gg/customer-panel
                    buyer.email: buyer@example.com
                    order.id: a2855h0p1y4-71329ed4d95-1000427
                    order.paid_at: Oct 22, 2026 at 4:20 PM UTC
                    order.total: $39.99
                    order.paid_with: Credit/Debit Card (Stripe)
                    order.invoice_attached: false
                    links.order: >-
                      https://northwind.myshoply.gg/customer-panel/orders/a2855h0p1y4-71329ed4d95-1000427/
                    links.review: >-
                      http://localhost:3002/checkout/a2855h0p1y4-71329ed4d95-1000427#review
                    year: '2026'
                  problems:
                    html: []
                    css: []
                    subject: []
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Refused'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.emailTemplates.preview("KIND");
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->emailTemplates->preview('KIND');
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.emailTemplates.preview("KIND")
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A word of your own for this one change, up to 180 letters, digits, dots,
        dashes, underscores and colons. Sent again with the same key, the
        request is not carried out twice: the first answer comes back, with
        `Idempotent-Replay: true`.
      schema:
        type: string
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    Refused:
      description: >-
        The request was understood and not carried out. `validation_failed` says
        what is wrong with each field under `errors`; other codes are the
        route's own.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.