Generate the rendered preview of transactional template

Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an email address (to populate variables from the contact”s attributes) or a params object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory templateId. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.

Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an `email` address (to populate variables from the contact''s attributes) or a `params` object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory `templateId`. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Values to fetch Template preview

anyRequired

Response

successfully fetched template's preview fields

fromEmailstring

Sender email address

fromNamestring

Sender Name

htmlstring

Html content of the template

previewTextstring

Preview text of the template

subjectstring

subject of the template

usedFeedNameslist of strings

Errors

400

Bad Request Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.transactionalEmails.postPreviewSmtpEmailTemplates();
8	}
9	main();

1	{
2	"fromEmail": "nikon.doe@example.com",
3	"fromName": "Nikon Doe",
4	"html": "<!DOCTYPE html><html><head><title>Preview html content</title></head><body><p>html content</p></body></html>",
5	"previewText": "Preview text",
6	"subject": "Template preview subject",
7	"usedFeedNames": [
8	"[\"feed_1\",\"feed_2\"]"
9	]
10	}