Skip to content

Latest commit

 

History

History
38 lines (35 loc) · 6.37 KB

CreateEmailCampaign.md

File metadata and controls

38 lines (35 loc) · 6.37 KB
Raw

Brevo::CreateEmailCampaign

Properties

Name Type Description Notes
tag String Tag of the campaign [optional]
sender CreateEmailCampaignSender
name String Name of the campaign
html_content String Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) [optional]
html_url String Mandatory if htmlContent and templateId are empty. Url to the message (HTML) [optional]
template_id Integer 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. [optional]
scheduled_at String 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). [optional]
subject String Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. [optional]
preview_text String Preview text or preheader of the email campaign [optional]
reply_to String Email on which the campaign recipients will be able to reply to [optional]
to_field String 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 [optional]
recipients CreateEmailCampaignRecipients [optional]
attachment_url String 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 [optional]
inline_image_activation BOOLEAN 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 [optional] [default to false]
mirror_active BOOLEAN Use true to enable the mirror link [optional]
footer String Footer of the email campaign [optional]
header String Header of the email campaign [optional]
utm_campaign String Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed [optional]
params Object 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' [optional]
send_at_best_time BOOLEAN Set this to true if you want to send your campaign at best time. [optional] [default to false]
ab_testing BOOLEAN 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 [optional] [default to false]
subject_a String Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value [optional]
subject_b String Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value [optional]
split_rule Integer 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 [optional]
winner_criteria String Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed [optional]
winner_delay Integer 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 [optional]
ip_warmup_enable BOOLEAN Available for dedicated ip clients. Set this to true if you wish to warm up your ip. [optional] [default to false]
initial_quota Integer 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. [optional]
increase_rate Integer 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%. [optional]
unsubscription_page_id String 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. [optional]
update_form_id String 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. [optional]