Skip to content

Latest commit

 

History

History
43 lines (39 loc) · 4.7 KB

GetExtendedCampaignOverview.md

File metadata and controls

43 lines (39 loc) · 4.7 KB
Raw

GetExtendedCampaignOverview

Properties

Name Type Description Notes
Id int64 ID of the campaign [default to null]
Name string Name of the campaign [default to null]
Subject string Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` [optional] [default to null]
PreviewText string Preview text or preheader of the email campaign [optional] [default to null]
Type_ string Type of campaign [default to null]
Status string Status of the campaign [default to null]
ScheduledAt string UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) [optional] [default to null]
AbTesting bool Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. [optional] [default to null]
SubjectA string Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` [optional] [default to null]
SubjectB string Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` [optional] [default to null]
SplitRule int32 The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` [optional] [default to null]
WinnerCriteria string Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` [optional] [default to null]
WinnerDelay int32 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] [default to null]
SendAtBestTime bool It is true if you have chosen to send your campaign at best time, otherwise it is false [optional] [default to null]
UtmCampaignValue string utm parameter associated with campaign [optional] [default to null]
UtmSource string source of utm parameter [optional] [default to null]
UtmMedium string medium parameter [optional] [default to null]
UtmID int32 utm id [optional] [default to null]
TestSent bool Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) [default to null]
Header string Header of the campaign [default to null]
Footer string Footer of the campaign [default to null]
Sender *GetExtendedCampaignOverviewSender [default to null]
ReplyTo string Email defined as the "Reply to" of the campaign [default to null]
ToField string Customisation of the "to" field of the campaign [optional] [default to null]
HtmlContent string HTML content of the campaign [default to null]
ShareLink string Link to share the campaign on social medias [optional] [default to null]
Tag string Tag of the campaign [optional] [default to null]
CreatedAt string Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) [default to null]
ModifiedAt string UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) [default to null]
InlineImageActivation bool Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. [optional] [default to null]
MirrorActive bool Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign [optional] [default to null]
Recurring bool 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] [default to null]
SentDate string Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' [optional] [default to null]
ReturnBounce int64 Total number of non-delivered campaigns for a particular campaign id. [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]