Skip to main content
GET
Preview a rendered email template with sample data and tenant branding
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /email-templates//preview Description: Renders the named template with built-in sample data and the tenant’s resolved branding. By default returns rendered HTML/text alongside metadata as JSON; pass ?format=html to get the raw rendered HTML document directly (for embedding in an iframe). Authorization:
  • Required role: admin or higher
Method: GET

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

templateName
string
required

Query Parameters

format
enum<string>

Pass html to receive the raw rendered HTML document instead of the JSON envelope.

Available options:
html

Response

Template preview generated

status
string
Example:

"success"

message
string
data
object