| tag |
str |
Tag of the campaign |
[optional] |
| sender |
CreateEmailCampaignSender |
|
|
| name |
str |
Name of the campaign |
|
| html_content |
str |
Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) |
[optional] |
| html_url |
str |
Mandatory if htmlContent and templateId are empty. Url to the message (HTML) |
[optional] |
| template_id |
int |
Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. |
[optional] |
| scheduled_at |
datetime |
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 |
str |
Subject of the campaign |
|
| reply_to |
str |
Email on which the campaign recipients will be able to reply to |
[optional] |
| to_field |
str |
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 SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization |
[optional] |
| recipients |
CreateEmailCampaignRecipients |
|
[optional] |
| attachment_url |
str |
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 |
bool |
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 |
bool |
Use true to enable the mirror link |
[optional] |
| footer |
str |
Footer of the email campaign |
[optional] |
| header |
str |
Header of the email campaign |
[optional] |
| utm_campaign |
str |
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 |
bool |
Set this to true if you want to send your campaign at best time. |
[optional] [default to False] |