Create SMTP Template

Options

Body

values to update in transactional email template

Request body which must comply to the following JSON Schema:

{
  "required" : [ "sender", "subject", "templateName" ],
  "type" : "object",
  "properties" : {
    "tag" : {
      "type" : "string",
      "description" : "Tag of the template",
      "example" : "OrderConfirmation"
    },
    "sender" : {
      "type" : "object",
      "properties" : {
        "name" : {
          "type" : "string",
          "description" : "Name of the sender. **If not passed, will be set to default**\n",
          "example" : "Mary from MyShop"
        },
        "email" : {
          "type" : "string",
          "description" : "Email of the sender",
          "format" : "email",
          "example" : "contact@myshop.com"
        },
        "id" : {
          "type" : "integer",
          "description" : "Select the sender for the template on the basis of sender id.\n_In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_.\n",
          "format" : "int64",
          "example" : 3
        }
      },
      "description" : "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:\n**{\"name\":\"xyz\", \"email\":\"example@abc.com\"}**\n**{\"name\":\"xyz\", \"id\":123}**\n"
    },
    "templateName" : {
      "type" : "string",
      "description" : "Name of the template",
      "example" : "Order Confirmation - EN"
    },
    "htmlContent" : {
      "type" : "string",
      "description" : "Body of the message (HTML version). The field must have more than 10 characters. **REQUIRED if htmlUrl is empty**\n",
      "example" : "The order n°xxxxx has been confirmed. Thanks for your purchase"
    },
    "htmlUrl" : {
      "type" : "string",
      "description" : "Url which contents the body of the email message. REQUIRED if htmlContent is empty",
      "format" : "url",
      "example" : "https://html.domain.com"
    },
    "subject" : {
      "type" : "string",
      "description" : "Subject of the template",
      "example" : "Thanks for your purchase !"
    },
    "replyTo" : {
      "type" : "string",
      "description" : "Email on which campaign recipients will be able to reply to",
      "format" : "email",
      "example" : "support@myshop.com"
    },
    "toField" : {
      "type" : "string",
      "description" : "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\n",
      "example" : "{FNAME} {LNAME}"
    },
    "attachmentUrl" : {
      "type" : "string",
      "description" : "Absolute url of the attachment (**no local file**). Extension allowed:\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 and eps'\n",
      "format" : "url",
      "example" : "https://attachment.domain.com"
    },
    "isActive" : {
      "type" : "boolean",
      "description" : "Status of template. isActive = true means template is active and isActive = false means template is inactive",
      "example" : true
    }
  }
}

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