Id |
long? |
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] |
PreviewText |
string |
Preview text or preheader of the email campaign |
[optional] |
Type |
string |
Type of campaign |
|
Status |
string |
Status of the campaign |
|
ScheduledAt |
string |
UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) |
[optional] |
AbTesting |
bool? |
Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. |
[optional] |
SubjectA |
string |
Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` |
[optional] |
SubjectB |
string |
Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` |
[optional] |
SplitRule |
int? |
The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` |
[optional] |
WinnerCriteria |
string |
Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` |
[optional] |
WinnerDelay |
int? |
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] |
SendAtBestTime |
bool? |
It is true if you have chosen to send your campaign at best time, otherwise it is false |
[optional] |
TestSent |
bool? |
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 |
GetExtendedCampaignOverviewSender |
|
|
ReplyTo |
string |
Email defined as the "Reply to" of the campaign |
|
ToField |
string |
Customisation of the "to" field of the campaign |
[optional] |
HtmlContent |
string |
HTML content of the campaign |
|
ShareLink |
string |
Link to share the campaign on social medias |
[optional] |
Tag |
string |
Tag of the campaign |
[optional] |
CreatedAt |
string |
Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
ModifiedAt |
string |
UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
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] |
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] |
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] |
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] |
ReturnBounce |
long? |
Total number of non-delivered campaigns for a particular campaign id. |
[optional] |
Recipients |
Object |
|
|
Statistics |
Object |
|
|