Send a transactional email
Options
- Body
- Values to send a transactional email
Request body which must comply to the following JSON Schema:
{ "type" : "object", "properties" : { "sender" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "description: Name of the sender from which the emails will be sent. **Maximum allowed characters are 70**. Applicable only when email is passed.\n", "example" : "Mary from MyShop" }, "email" : { "type" : "string", "description" : "Email of the sender from which the emails will be sent. Mandatory if sender id is not passed.", "format" : "email", "example" : "no-reply@myshop.com" }, "id" : { "type" : "integer", "description" : "Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed.", "format" : "int64", "example" : 2 } }, "description" : "**Mandatory if `templateId` is not passed**. Pass name (_optional_) and email or id of sender from which emails will be sent. **`name` will be ignored if passed along with sender `id`**. For example,\n**{\"name\":\"Mary from MyShop\", \"email\":\"no-reply@myshop.com\"}**\n**{\"id\":2}**\n" }, "to" : { "type" : "array", "description" : "**Mandatory if messageVersions are not passed, ignored if messageVersions are passed**\nList of email addresses and names (_optional_) of the recipients. For example,\n**[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]**\n", "items" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address of the recipient", "format" : "email", "example" : "jimmy98@example.com" }, "name" : { "type" : "string", "description" : "Name of the recipient. **Maximum allowed characters are 70**.\n", "example" : "Jimmy" } } } }, "bcc" : { "type" : "array", "description" : "List of email addresses and names (_optional_) of the recipients in bcc\n", "items" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address of the recipient in bcc", "format" : "email", "example" : "helen9766@example.com" }, "name" : { "type" : "string", "description" : "Name of the recipient in bcc. **Maximum allowed characters are 70**.\n", "example" : "Helen" } } } }, "cc" : { "type" : "array", "description" : "List of email addresses and names (_optional_) of the recipients in cc\n", "items" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address of the recipient in cc", "format" : "email", "example" : "ann6533@example.com" }, "name" : { "type" : "string", "description" : "Name of the recipient in cc. **Maximum allowed characters are 70**.\n", "example" : "Ann" } } } }, "htmlContent" : { "type" : "string", "description" : "HTML body of the message. **Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed**\n", "example" : "<!DOCTYPE html> <html> <body> <h1>Confirm you email</h1> <p>Please confirm your email address by clicking on the link below</p> </body> </html>" }, "textContent" : { "type" : "string", "description" : "Plain Text body of the message. **Ignored if 'templateId' is passed**\n", "example" : "Please confirm your email address by clicking on the link https://text.domain.com" }, "subject" : { "type" : "string", "description" : "Subject of the message. **Mandatory if 'templateId' is not passed**\n", "example" : "Login Email confirmation" }, "replyTo" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address in reply to", "format" : "email", "example" : "ann6533@example.com" }, "name" : { "type" : "string", "description" : "Name in reply to. **Maximum allowed characters are 70**.\n", "example" : "Ann" } }, "description" : "Email (**required**), along with name (_optional_), on which transactional mail recipients will be able to reply back. For example,\n**{\"email\":\"ann6533@example.com\", \"name\":\"Ann\"}**\n" }, "attachment" : { "type" : "array", "description" : "Pass the _absolute URL_ (**no local file**) or the _base64 content_ of the attachment along with the attachment name. **Mandatory if attachment content is passed**. For example,\n**[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]**.\nAllowed extensions for attachment file:\n#### 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 and xlsm.\nIf `templateId` is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then `attachment` is ignored\n", "items" : { "type" : "object", "properties" : { "url" : { "type" : "string", "description" : "Absolute url of the attachment (**no local file**).\n", "format" : "url", "example" : "https://attachment.domain.com/myAttachmentFromUrl.jpg" }, "content" : { "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type" : "string", "description" : "Base64 encoded chunk data of the attachment generated on the fly", "format" : "byte", "example" : "YjNKa1pYSXVjR1Jt" }, "name" : { "type" : "string", "description" : "**Required if content is passed**. Name of the attachment\n", "example" : "myAttachment.png" } } } }, "headers" : { "type" : "object", "additionalProperties" : { }, "description" : "Pass the set of custom headers (_not the standard headers_) that shall be sent along the mail headers in the original email. **'sender.ip'** header can be set (**only for dedicated ip users**) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example,\n**{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}**.\n", "example" : { "sender.ip" : "1.2.3.4", "X-Mailin-custom" : "some_custom_header", "idempotencyKey" : "abc-123" } }, "templateId" : { "type" : "integer", "description" : "Id of the template.", "format" : "int64", "example" : 2 }, "params" : { "type" : "object", "additionalProperties" : { }, "description" : "Pass the set of attributes to customize the template. For example, **{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}**. It's **considered only if template is in New Template Language format**.\n", "example" : { "FNAME" : "Joe", "LNAME" : "Doe" } }, "messageVersions" : { "type" : "array", "description" : "You can customize and send out multiple versions of a mail. **templateId** can be customized only if global parameter contains templateId. **htmlContent and textContent** can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version.\nTotal number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version.\nThe size of individual params in all the messageVersions shall not exceed **100 KB** limit and that of cumulative params shall not exceed **1000 KB**.\nYou can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - **https://developers.brevo.com/docs/batch-send-transactional-emails**\n", "items" : { "required" : [ "to" ], "type" : "object", "properties" : { "to" : { "type" : "array", "description" : "List of email addresses and names (_optional_) of the recipients. For example,\n**[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]**\n", "items" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address of the recipient", "format" : "email", "example" : "jimmy98@example.com" }, "name" : { "type" : "string", "description" : "Name of the recipient. **Maximum allowed characters are 70**.\n", "example" : "Jimmy" } } } }, "params" : { "type" : "object", "additionalProperties" : { }, "description" : "Pass the set of attributes to customize the template. For example, **{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}**. It's **considered only if template is in New Template Language format**.\n", "example" : { "FNAME" : "Joe", "LNAME" : "Doe" } }, "bcc" : { "type" : "array", "description" : "List of email addresses and names (_optional_) of the recipients in bcc\n", "items" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address of the recipient in bcc", "format" : "email", "example" : "helen9766@example.com" }, "name" : { "type" : "string", "description" : "Name of the recipient in bcc. **Maximum allowed characters are 70**.\n", "example" : "Helen" } } } }, "cc" : { "type" : "array", "description" : "List of email addresses and names (_optional_) of the recipients in cc\n", "items" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address of the recipient in cc", "format" : "email", "example" : "ann6533@example.com" }, "name" : { "type" : "string", "description" : "Name of the recipient in cc. **Maximum allowed characters are 70**.\n", "example" : "Ann" } } } }, "replyTo" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address in reply to", "format" : "email", "example" : "ann6533@example.com" }, "name" : { "type" : "string", "description" : "Name in reply to. **Maximum allowed characters are 70**.\n", "example" : "Ann" } }, "description" : "Email (**required**), along with name (_optional_), on which transactional mail recipients will be able to reply back. For example,\n**{\"email\":\"ann6533@example.com\", \"name\":\"Ann\"}**\n" }, "subject" : { "type" : "string", "description" : "Custom subject specific to message version\n", "example" : "Login Email confirmation" }, "htmlContent" : { "type" : "string", "description" : "HTML body of the message. **Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed**\n", "example" : "<!DOCTYPE html> <html> <body> <h1>Confirm you email</h1> <p>Please confirm your email address by clicking on the link below</p> </body> </html>" }, "textContent" : { "type" : "string", "description" : "Plain Text body of the message. **Ignored if 'templateId' is passed**\n", "example" : "Please confirm your email address by clicking on the link https://text.domain.com" } } } }, "tags" : { "type" : "array", "description" : "Tag your emails to find them more easily", "items" : { "type" : "string", "example" : "tag1" } }, "scheduledAt" : { "type" : "string", "description" : "UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**.", "format" : "date-time", "example" : "2022-04-05T12:30:00+02:00" }, "batchId" : { "type" : "string", "description" : "Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end.", "example" : "5c6cfa04-eed9-42c2-8b5c-6d470d978e9d" } } } - Result Format
Specify how the response should be mapped to the table output. The following formats are available:
Raw Response: Returns the raw response in a single row with the following columns:
- body: Response body
- status: HTTP status code
Views
- This node has no views
Workflows
- No workflows found
Links
- No links available
Developers
You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.
To use this node in KNIME, install the extension Brevo from the below update site following our NodePit Product and Node Installation Guide:
v5.3
A zipped version of the software site can be downloaded here.
Plugin provider: NodePit
Plugin version: 1.0.1.202407051339
On NodePit since: 2024-07-09
Last update: 2024-11-21
KNIME versions: Since v4.7
NodePit ExclusiveOnly available on NodePit
Deploy, schedule, execute, and monitor your KNIME workflows locally, in the cloud or on-premises – with our brand new NodePit Runner.
Try NodePit Runner!Contact
Do you have feedback, questions, comments about NodePit, want to support this platform, or want your own nodes or workflows listed here as well? Do you think, the search results could be improved or something is missing? Then please get in touch! Alternatively, you can send us an email to mail@nodepit.com.
Please note that this is only about NodePit. We do not provide general support for KNIME — please use the KNIME forums instead.