Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Email Campaigns

Create an email campaign

post/emailCampaigns

Request body

tagstring

Tag of the campaign

namestring required

Name of the campaign

htmlContentstring

Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)

htmlUrlstring url

Mandatory if htmlContent and templateId are empty. Url to the message (HTML)

templateIdinteger

Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.

scheduledAtstring

Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).

subjectstring

Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.

previewTextstring

Preview text or preheader of the email campaign

replyTostring email

Email on which the campaign recipients will be able to reply to

toFieldstring

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

attachmentUrlstring 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

inlineImageActivationboolean

Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts

mirrorActiveboolean

Use true to enable the mirror link

footerstring

Footer of the email campaign

headerstring

Header of the email campaign

utmCampaignstring

Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed

paramsobject

Pass the set of attributes to customize the type classic campaign. For example, {"FNAME":"Joe", "LNAME":"Doe"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'

sendAtBestTimeboolean

Set this to true if you want to send your campaign at best time.

abTestingboolean

Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B

subjectAstring

Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value

subjectBstring

Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value

splitRuleinteger

Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else

winnerCriteria'open' | 'click'

Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed

winnerDelayinteger

Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed

ipWarmupEnableboolean

Available for dedicated ip clients. Set this to true if you wish to warm up your ip.

initialQuotainteger

Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.

increaseRateinteger

Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.

unsubscriptionPageIdstring

Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used.

updateFormIdstring

Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.

Example request

{
  "tag": "Newsletter",
  "sender": {
    "name": "Mary from MyShop",
    "email": "newsletter@myshop.com",
    "id": 3
  },
  "name": "Newsletter - May 2017",
  "htmlContent": "<!DOCTYPE html> <html> <body> <h1>Confirm you email</h1> <p>Please confirm your email address by clicking on the link below</p> </body> </html>",
  "htmlUrl": "https://html.domain.com",
  "scheduledAt": "2017-06-01T12:30:00+02:00",
  "subject": "Discover the New Collection !",
  "previewText": "Thanks for your order!",
  "replyTo": "support@myshop.com",
  "toField": "{FNAME} {LNAME}",
  "recipients": {
    "exclusionListIds": [
      8
    ],
    "listIds": [
      32
    ],
    "segmentIds": [
      23
    ]
  },
  "attachmentUrl": "https://attachment.domain.com",
  "inlineImageActivation": true,
  "mirrorActive": true,
  "footer": "[DEFAULT_FOOTER]",
  "header": "[DEFAULT_HEADER]",
  "utmCampaign": "NL_05_2017",
  "params": {
    "FNAME": "Joe",
    "LNAME": "Doe"
  },
  "sendAtBestTime": true,
  "abTesting": true,
  "subjectA": "Discover the New Collection!",
  "subjectB": "Want to discover the New Collection?",
  "splitRule": 50,
  "winnerCriteria": "open",
  "winnerDelay": 50,
  "ipWarmupEnable": true,
  "initialQuota": 3000,
  "increaseRate": 70,
  "unsubscriptionPageId": "62cbb7fabbe85021021aac52",
  "updateFormId": "6313436b9ad40e23b371d095"
}

Response

Email campaign created

idinteger required

ID of the object created

Example response

{
  "id": 122
}