Campaign_Get_Info

Campaign_Get_Info( string keyint campaignId)
 

Note: When using one of the API wrappers, you do not need to pass the API key. The wrapper will pass the key for you, your first parameter should be the second parameter in the signature.

Description

Get Info for a specified Campaign
 

Parameters

string key Your API key - used to authenticate your account
int campaignId The Campaign ID of the Campaign you want Info on

Return
struct  

Return structure will include:

int campaignId The ID of this Campaign
string campaignName The internal use name of this Campaign
string status The current status of this campaign
struct recipients The lists, groups, searches or ad hoc email addresses this campaign will be/has been sent to
string subject The subject line of the Campaign
string senderEmail The from email address of the Campaign
string senderName The from name of the Campaign
struct content A struct containing the content of the Campaign email
bool authenticate Authentication applies certain identifiers to your message to let the receiving servers know where the message is coming from. This helps with delivery of large mailings to major ISPs and some spam filters who often look for these identifiers to determine if a message is legit or not.
string replyToEmail The email address that replies to your Campaign should go to. This will be overridden if you set trackReplies to true.
string replyToName The display name of the replyToEmail
bool trackReplies Whether or not replies should be tracked in your Campaign Report. Setting this to true will override your replyToEmail
bool recipientName The display name of your recipient. Can use Personalization Tokens
bool showInArchive Whether or not this message should be show in your message archive.
bool viewInBrowser Whether or not this message should include a "View In Browser" link.
bool trackOpens Whether or not opens for this message should be tracked in your Campaign Report
bool trackClickThruHTML Whether or not click tracking for links in the HTML body of this message should be tracked in your Campaign Report
bool trackClickThruText Whether or not click tracking for links in the text body of this message should be tracked in your Campaign Report
string googleAnalyticsName The Google Analytics tracking name for this Campaign. See Campaign_Create_Standard for more info.
string clickTaleName The ClickTale tracking name for this Campaign. See Campaign_Create_Standard for more info.
array clickTaleCustomFields The ClickTale tracking custom fields for this Campaign. See Campaign_Create_Standard for more info.
array facebookAutopost Facebook post details
array twitterAutopost Twitter post details  

Still need help? Contact Us Contact Us