GetEmailCampaign.md

GetEmailCampaign

Properties

Name	Type	Description	Notes
id	int	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]
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	\Brevo\Client\Model\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	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]