Create an email template | Brevo API Documentation

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.

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`.

Authentication

api-keystring

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

Request

values to update in transactional email template

senderobjectRequired

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}**

subjectstringRequired

Subject of the template

templateNamestringRequired

Name of the template

attachmentUrlstringOptionalformat: "url"

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’

htmlContentstringOptional

Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty

htmlUrlstringOptionalformat: "url"

Url which contents the body of the email message. REQUIRED if htmlContent is empty

isActivebooleanOptional

Status of template. isActive = true means template is active and isActive = false means template is inactive

replyTostringOptionalformat: "email"

Email on which campaign recipients will be able to reply to

tagstringOptional

Tag of the template

toFieldstringOptional

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

Response

successfully created

idlong

ID of the object created

Errors

400

Bad Request Error

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

values to update in transactional email template

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}

Subject of the template

Name of the template

Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty

Url which contents the body of the email message. REQUIRED if htmlContent is empty

Status of template. isActive = true means template is active and isActive = false means template is inactive

Email on which campaign recipients will be able to reply to

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

successfully created

ID of the object created

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.createSmtpTemplate({
8	subject: "Thanks for your purchase !",
9	templateName: "Order Confirmation - EN",
10	});
11	}
12	main();