Skip to main content
POST
Send a test email using the specified template and tenant branding
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /email-templates//test Description: Renders the named template with sample data (optionally merged with customData) and the tenant’s branding, then sends it via the tenant’s configured email sending path. Defaults to the current user’s email if to is omitted. Authorization:
  • Required role: admin or higher
Method: POST

Code Examples

Authorizations

Authorization
string
header
required

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

Path Parameters

templateName
string
required

Body

application/json
to
string

Recipient email. Defaults to the current user's email if omitted.

Example:

"you@yourlabel.com"

customData
object

Merged over the template's built-in sample data before rendering.

Response

Test email sent

status
string
Example:

"success"

message
string
Example:

"Test email sent successfully"

data
object