POST /smtp/template/preview
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.
Servers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
params |
Object | No |
Key-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: {"Firstname":"John", "Lastname":"Doe"} |
params.Firstname |
String | No |
firstname of the contact. Dynamic parameter |
params.Lastname |
String | No |
Lastname of the contact. Dynamic parameter |
email |
String | No |
Email of the contact.(Required if params not provided) |
templateId |
Integer | Yes |
Id of the template. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.