GetEmailCampaign.md

GetEmailCampaign

Properties

Name	Type	Description	Notes
id	int	ID of the campaign
name	str	Name of the campaign
subject	str	Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`	[optional]
preview_text	str	Preview text or preheader of the email campaign	[optional]
type	str	Type of campaign
status	str	Status of the campaign
scheduled_at	str	UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)	[optional]
ab_testing	bool	Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.	[optional]
subject_a	str	Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`	[optional]
subject_b	str	Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`	[optional]
split_rule	int	The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`	[optional]
winner_criteria	str	Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`	[optional]
winner_delay	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]
send_at_best_time	bool	It is true if you have chosen to send your campaign at best time, otherwise it is false	[optional]
utm_campaign_value	str	utm parameter associated with campaign	[optional]
utm_source	str	source of utm parameter	[optional]
utm_medium	str	medium parameter	[optional]
utm_id	int	utm id	[optional]
test_sent	bool	Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
header	str	Header of the campaign
footer	str	Footer of the campaign
sender	GetExtendedCampaignOverviewSender
reply_to	str	Email defined as the "Reply to" of the campaign
to_field	str	Customisation of the "to" field of the campaign	[optional]
html_content	str	HTML content of the campaign
share_link	str	Link to share the campaign on social medias	[optional]
tag	str	Tag of the campaign	[optional]
created_at	str	Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
modified_at	str	UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
inline_image_activation	bool	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	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]
sent_date	str	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	int	Total number of non-delivered campaigns for a particular campaign id.	[optional]
recipients	object
statistics	object

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