POST /smtp/templates
Create a new transactional email template with the specified sender, subject, and content. The sender, subject, and templateName fields are required. Template content can be provided via htmlContent (minimum 10 characters) or htmlUrl; at least one must be supplied. Templates are created as inactive by default unless isActive is explicitly set to true.
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 |
|---|---|---|---|
htmlContent |
String | No |
Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty |
htmlUrl |
String | No |
Url which contents the body of the email message. REQUIRED if htmlContent is empty |
replyTo |
String | No |
Email on which campaign recipients will be able to reply to |
isActive |
Boolean | No |
Status of template. isActive = true means template is active and isActive = false means template is inactive |
sender |
Object | Yes |
Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: {"name":"xyz", "email":"example@abc.com"} {"name":"xyz", "id":123} |
sender.id |
Integer | No |
Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). |
sender.email |
String | No |
Email of the sender |
sender.name |
String | No |
Name of the sender. If not passed, will be set to default |
templateName |
String | Yes |
Name of the template |
subject |
String | Yes |
Subject of the template |
toField |
String | No |
To personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization |
attachmentUrl |
String | No |
Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps' |
tag |
String | No |
Tag 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.