Skip to content

Latest commit

 

History

History
88 lines (82 loc) · 5.34 KB

GetEmailCampaignsCampaignsInner.md

File metadata and controls

88 lines (82 loc) · 5.34 KB

Brevo::GetEmailCampaignsCampaignsInner

Properties

Name Type Description Notes
id Integer ID of the campaign
name String Name of the campaign
subject String Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` [optional]
preview_text String Preview text or preheader of the email campaign [optional]
type String Type of campaign
status String Status of the campaign
scheduled_at String UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) [optional]
ab_testing Boolean Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. [optional]
subject_a String Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` [optional]
subject_b String Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` [optional]
split_rule Integer The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` [optional]
winner_criteria String Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` [optional]
winner_delay Integer The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` [optional]
send_at_best_time Boolean It is true if you have chosen to send your campaign at best time, otherwise it is false [optional]
utm_campaign_value String utm parameter associated with campaign [optional]
utm_source String [optional]
utm_medium String [optional]
utm_id Integer utm id [optional]
test_sent Boolean Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
header String Header of the campaign
footer String Footer of the campaign
sender GetExtendedCampaignOverviewAllOfSender
reply_to String Email defined as the "Reply to" of the campaign
to_field String Customisation of the "to" field of the campaign [optional]
html_content String HTML content of the campaign
share_link String Link to share the campaign on social medias [optional]
tag String Tag of the campaign [optional]
created_at String Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
modified_at String UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
inline_image_activation Boolean Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. [optional]
mirror_active Boolean Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign [optional]
recurring Boolean FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times [optional]
sent_date String Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' [optional]
return_bounce Integer Total number of non-delivered campaigns for a particular campaign id. [optional]
recipients GetCampaignRecipients
statistics GetExtendedCampaignStats

Example

require 'brevo'

instance = Brevo::GetEmailCampaignsCampaignsInner.new(
  id: 12,
  name: EN - Sales Summer 2017,
  subject: 20% OFF for 2017 Summer Sales,
  preview_text: Thanks for your order!,
  type: classic,
  status: sent,
  scheduled_at: 2017-06-01T12:30:00Z,
  ab_testing: true,
  subject_a: Discover the New Collection!,
  subject_b: Want to discover the New Collection?,
  split_rule: 25,
  winner_criteria: open,
  winner_delay: 50,
  send_at_best_time: true,
  utm_campaign_value: myutm,
  utm_source: Brevo,
  utm_medium: EMAIL,
  utm_id: 10,
  test_sent: true,
  header: [DEFAULT_HEADER],
  footer: [DEFAULT_FOOTER],
  sender: null,
  reply_to: replyto@domain.com,
  to_field: {FNAME} {LNAME},
  html_content: This is my HTML Content,
  share_link: http://dhh.brevo.com/fhsgccc.html?t=9865448900,
  tag: Newsletter,
  created_at: 2017-05-01T12:30:00Z,
  modified_at: 2017-05-01T12:30:00Z,
  inline_image_activation: true,
  mirror_active: true,
  recurring: true,
  sent_date: 2018-12-01T16:30:00Z,
  return_bounce: 5,
  recipients: null,
  statistics: null
)