Skip to content

CreateEmailCampaign.md

Latest commit

 

History

History
38 lines (28 loc) · 3.01 KB

CreateEmailCampaign.md

File metadata and controls

38 lines (28 loc) · 3.01 KB

SibApiV3Sdk.CreateEmailCampaign

Properties

Name Type Description Notes
tag String Tag of the campaign [optional]
sender CreateEmailCampaignSender
name String Name of the campaign
htmlContent String Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) [optional]
htmlUrl String Mandatory if htmlContent and templateId are empty. Url to the message (HTML) [optional]
templateId Number 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]
scheduledAt Date Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. [optional]
subject String Subject of the campaign
replyTo String Email on which the campaign recipients will be able to reply to [optional]
toField 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 SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization [optional]
recipients CreateEmailCampaignRecipients [optional]
attachmentUrl 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]
inlineImageActivation 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]
mirrorActive Boolean Use true to enable the mirror link [optional]
recurring Boolean For trigger campagins use false to make sure a contact receives the same campaign only once [optional] [default to false]
type String Type of the campaign
footer String Footer of the email campaign [optional]
header String Header of the email campaign [optional]
utmCampaign 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' [optional]

Enum: TypeEnum

  • classic (value: "classic")

  • trigger (value: "trigger")