Pricing Templates
Log in Sign up
Integrations / Brevo / ...

POST /smtp/email

Send a transactional email

Servers

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

HTML body content of the email. Required when templateId is not provided. Ignored when templateId is provided.
messageVersions[] Array No

Array of message version objects for sending customized email variants. The templateId can be customized per version only if a global templateId is provided. The htmlContent and textContent can be customized per version only if at least one of these is present in the global parameters. Global parameters such as to (required), bcc, cc, replyTo, and subject can be customized per version. Maximum total recipients per API request is 2000. Maximum recipients per message version is 99. Individual params objects must not exceed 100 KB. Cumulative params across all versions must not exceed 1000 KB. See https://developers.brevo.com/docs/batch-send-transactional-emails for detailed usage instructions.
messageVersions[].to[] Array Yes

Array of recipient objects. Each object contains an email address and an optional display name.
messageVersions[].to[].email String Yes

Email address of the recipient
messageVersions[].to[].name String No

Display name of the recipient. Maximum length is 70 characters.
messageVersions[].params Object No

Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format.
messageVersions[].htmlContent String No

HTML body content of the email. Required when templateId is not provided. Ignored when templateId is provided.
messageVersions[].cc[] Array No

Array of CC recipient objects. Each object contains an email address and an optional name.
messageVersions[].cc[].email String Yes

CC recipient email address
messageVersions[].cc[].name String No

Display name of the CC recipient. Maximum length is 70 characters.
messageVersions[].bcc[] Array No

Array of BCC recipient objects. Each object contains an email address and an optional name.
messageVersions[].bcc[].email String Yes

BCC recipient email address
messageVersions[].bcc[].name String No

Display name of the BCC recipient. Maximum length is 70 characters.
messageVersions[].replyTo Object No

Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.
messageVersions[].replyTo.email String Yes

Email address in reply to
messageVersions[].replyTo.name String No

Display name for the reply-to address. Maximum length is 70 characters.
messageVersions[].textContent String No

Plain text body content of the email. Ignored when templateId is provided.
messageVersions[].subject String No

Email subject line for this message version
replyTo Object No

Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.
replyTo.email String Yes

Email address in reply to
replyTo.name String No

Display name for the reply-to address. Maximum length is 70 characters.
textContent String No

Plain text body content of the email. Ignored when templateId is provided.
sender Object No

Sender information. Required when templateId is not provided. Specify either an email address (with optional name) or a sender ID. The name field is ignored when id is provided.
sender.id Integer No

Sender identifier. Required when email is not provided. Use this field to select a sender with a specific IP pool (dedicated IP users only).
sender.email String No

Sender email address. Required when id is not provided.
sender.name String No

Display name of the sender. Maximum length is 70 characters. Only applicable when email is provided.
scheduledAt String No

UTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes.
subject String No

Email subject line. Required when templateId is not provided.
attachment[] Array No

Array of attachment objects. Each attachment must include either an absolute URL (no local file paths) or base64-encoded content, along with the attachment filename. The name field is required when content is provided. Supported file extensions: 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, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass, xlsm. When templateId is specified: if the template uses the New Template Language format, both url and content attachment types are supported; if the template uses the Old Template Language format, the attachment parameter is ignored.
attachment[].name String No

Attachment filename. Required when content is provided.
attachment[].url String No

Absolute URL of the attachment. Local file paths are not supported.
attachment[].content String No

Base64-encoded attachment data
to[] Array No

Array of recipient objects. Each object contains an email address and an optional display name. Required when messageVersions is not provided. Ignored when messageVersions is provided. Example: [{"name":"Jimmy", "email":"jimmy@example.com"}, {"name":"Joe", "email":"joe@example.com"}]
to[].email String Yes

Email address of the recipient
to[].name String No

Display name of the recipient. Maximum length is 70 characters.
params Object No

Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format.
batchId String No

UUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated.
templateId Integer No

Template identifier
cc[] Array No

Array of CC recipient objects. Each object contains an email address and an optional name.
cc[].email String Yes

CC recipient email address
cc[].name String No

Display name of the CC recipient. Maximum length is 70 characters.
bcc[] Array No

Array of BCC recipient objects. Each object contains an email address and an optional name.
bcc[].email String Yes

BCC recipient email address
bcc[].name String No

Display name of the BCC recipient. Maximum length is 70 characters.
tags[] Array No

Array of tags for categorizing and filtering emails
headers Object No

Custom email headers (non-standard headers) to include in the email. The sender.ip header can be set to specify the IP address used for sending transactional emails (dedicated IP users only). Header names must use Title-Case-Format (words separated by hyphens with the first letter of each word capitalized). Headers not in this format are automatically converted. Standard email headers are not supported. Example: {"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_value", "Idempotency-Key":"abc-123"}

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy