API Documentation

campaignCreate – v1.3

 campaignCreate(string apikey, string type, array options, array content, array segment_opts, array type_opts)

Create a new draft campaign to send. You can not have more than 32,000 campaigns in your account.

Section
Campaign Related

Parameters
apikey	a valid API Key for your user account. Get by visiting your API dashboard
type	the Campaign Type to create - one of "regular", "plaintext", "absplit", "rss", "auto"
options	a hash of the standard options for this campaign : string list_id the list to send this campaign to- get lists using lists() string subject the subject line for your campaign message string from_email the From: email address for your campaign message string from_name the From: name for your campaign message (not an email address) string to_name the To: name recipients will see (not email address) int template_id optional - use this user-created template to generate the HTML content of the campaign (takes precendence over other template options) int gallery_template_id optional - use a template from the public gallery to generate the HTML content of the campaign (takes precendence over base template options) int base_template_id optional - use this a base/start-from-scratch template to generate the HTML content of the campaign int folder_id optional - automatically file the new campaign in the folder_id passed. Get using folders() - note that Campaigns and Autoresponders have separate folder setupsn array tracking optional - set which recipient actions will be tracked, as a struct of boolean values with the following keys: "opens", "html_clicks", and "text_clicks". By default, opens and HTML clicks will be tracked. Click tracking can not be disabled for Free accounts. string title optional - an internal name to use for this campaign. By default, the campaign subject will be used. boolean authenticate optional - set to true to enable SenderID, DomainKeys, and DKIM authentication, defaults to false. array analytics optional - if provided, use a struct with "service type" as a key and the "service tag" as a value. Use "google" for Google Analytics, "clicktale" for ClickTale, and "gooal" for Goo.al tracking. The "tag" is any custom text (up to 50 characters) that should be included. boolean auto_footer optional - Whether or not we should auto-generate the footer for your content. Mostly useful for content from URLs or Imports boolean inline_css optional - Whether or not css should be automatically inlined when this campaign is sent, defaults to false. boolean generate_text optional - Whether of not to auto-generate your Text content from the HTML content. Note that this will be ignored if the Text part of the content passed is not empty, defaults to false. boolean auto_tweet optional - If set, this campaign will be auto-tweeted when it is sent - defaults to false. Note that if a Twitter account isn't linked, this will be silently ignored. array auto_fb_post optional - If set, this campaign will be auto-posted to the page_ids contained in the array. If a Facebook account isn't linked or the account does not have permission to post to the page_ids requested, those failures will be silently ignored. boolean fb_comments optional - If true, the Facebook comments (and thus the archive bar will be displayed. If false, Facebook comments will not be enabled (does not imply no archive bar, see previous link). Defaults to "true". boolean timewarp optional - If set, this campaign must be scheduled 24 hours in advance of sending - default to false. Only valid for "regular" campaigns and "absplit" campaigns that split on schedule_time. boolean ecomm360 optional - If set, our Ecommerce360 tracking will be enabled for links in the campaign array crm_tracking optional - If set, enable CRM tracking for: array salesforce optional - Enable SalesForce push back bool campaign optional - if true, create a Campaign object and update it with aggregate stats bool notes optional - if true, attempt to update Contact notes based on email address array highrise optional - Enable Highrise push back bool campaign optional - if true, create a Kase object and update it with aggregate stats bool notes optional - if true, attempt to update Contact notes based on email address array capsule optional - Enable Capsule push back (only notes are supported) bool notes optional - if true, attempt to update Contact notes based on email address
content	the content for this campaign - use a struct with the following keys: string html for pasted HTML content string text for the plain-text version string url to have us pull in content from a URL. Note, this will override any other content options - for lists with Email Format options, you'll need to turn on generate_text as well string archive to send a Base64 encoded archive file for us to import all media from. Note, this will override any other content options - for lists with Email Format options, you'll need to turn on generate_text as well string archive_type optional - only necessary for the "archive" option. Supported formats are: zip, tar.gz, tar.bz2, tar, tgz, tbz . If not included, we will default to zip   If you chose a template instead of pasting in your HTML content, then use "html_" followed by the template sections as keys - for example, use a key of "html_MAIN" to fill in the "MAIN" section of a template.
segment_opts	optional - if you wish to do Segmentation with this campaign this array should contain: see campaignSegmentTest(). It's suggested that you test your options against campaignSegmentTest().
type_opts	optional - For RSS Campaigns this, array should contain: string url the URL to pull RSS content from - it will be verified and must exist string schedule optional - one of "daily", "weekly", "monthly" - defaults to "daily" string schedule_hour optional - an hour between 0 and 24 - default to 4 (4am local time) - applies to all schedule types string schedule_weekday optional - for "weekly" only, a number specifying the day of the week to send: 0 (Sunday) - 6 (Saturday) - defaults to 1 (Monday) string schedule_monthday optional - for "monthly" only, a number specifying the day of the month to send (1 - 28) or "last" for the last day of a given month. Defaults to the 1st day of the month array days optional - used for "daily" schedules only, an array of the ISO-8601 weekday numbers to send on bool 1 optional - Monday, defaults to true bool 2 optional - Tuesday, defaults to true bool 3 optional - Wednesday, defaults to true bool 4 optional - Thursday, defaults to true bool 5 optional - Friday, defaults to true bool 6 optional - Saturday, defaults to true bool 7 optional - Sunday, defaults to true   For A/B Split campaigns, this array should contain: string split_test The values to segment based on. Currently, one of: "subject", "from_name", "schedule". NOTE, for "schedule", you will need to call campaignSchedule() separately! string pick_winner How the winner will be picked, one of: "opens" (by the open_rate), "clicks" (by the click rate), "manual" (you pick manually) int wait_units optional - the default time unit to wait before auto-selecting a winner - use "3600" for hours, "86400" for days. Defaults to 86400. int wait_time optional - the number of units to wait before auto-selecting a winner - defaults to 1, so if not set, a winner will be selected after 1 Day. int split_size optional - this is a percentage of what size the Campaign's List plus any segmentation options results in. "schedule" type forces 50%, all others default to 10% string from_name_a optional - sort of, required when split_test is "from_name" string from_name_b optional - sort of, required when split_test is "from_name" string from_email_a optional - sort of, required when split_test is "from_name" string from_email_b optional - sort of, required when split_test is "from_name" string subject_a optional - sort of, required when split_test is "subject" string subject_b optional - sort of, required when split_test is "subject"   For AutoResponder campaigns, this array should contain: string offset-units one of "hourly", "day", "week", "month", "year" - required string offset-time optional - , sort of - the number of units must be a number greater than 0 for signup based autoresponders, ignored for "hourly" string offset-dir either "before" or "after", ignored for "hourly" string event optional - "signup" (default) to base this members added to a list, "date", "annual", or "birthday" to base this on merge field in the list, "campaignOpen" or "campaignClicka" to base this on any activity for a campaign, "campaignClicko" to base this on clicks on a specific URL in a campaign, "mergeChanged" to base this on a specific merge field being changed to a specific value string event-datemerge optional - sort of, this is required if the event is "date", "annual", "birthday", or "mergeChanged" string campaign_id optional - sort of, required for "campaignOpen", "campaignClicka", or "campaignClicko" string campaign_url optional - sort of, required for "campaignClicko" int schedule_hour The hour of the day - 24 hour format in GMT - the autoresponder should be triggered, ignored for "hourly" boolean use_import_time whether or not imported subscribers (ie, any non-double optin subscribers) will receive array days optional - used for "daily" schedules only, an array of the ISO-8601 weekday numbers to send on bool 1 optional - Monday, defaults to true bool 2 optional - Tuesday, defaults to true bool 3 optional - Wednesday, defaults to true bool 4 optional - Thursday, defaults to true bool 5 optional - Friday, defaults to true bool 6 optional - Saturday, defaults to true bool 7 optional - Sunday, defaults to true

Returns
string	the ID for the created campaign

Examples (4)

download example code

[1] mcapi_campaignCreate.php

<?php
/**
This Example shows how to create a basic campaign via the MCAPI class.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$type = 'regular';
 
$opts['list_id'] = 'f9ee6d8616';
$opts['subject'] = 'Test Newsletter Subject';
$opts['from_email'] = 'mailchimp@example.org'; 
$opts['from_name'] = 'ACME, Inc.';
 
$opts['tracking']=array('opens' => true, 'html_clicks' => true, 'text_clicks' => false);
 
$opts['authenticate'] = true;
$opts['analytics'] = array('google'=>'my_google_analytics_key');
$opts['title'] = 'Test Newsletter Title';
 
$content = array('html'=>'some pretty html content *|UNSUB|* message', 
		  'text' => 'text text text *|UNSUB|*'
		);
/** OR we could use this:
$content = array('html_main'=>'some pretty html content',
		 'html_sidecolumn' => 'this goes in a side column',
		 'html_header' => 'this gets placed in the header',
		 'html_footer' => 'the footer with an *|UNSUB|* message', 
		 'text' => 'text content text content *|UNSUB|*'
		);
$opts['template_id'] = "1";
**/
 
$retval = $api->campaignCreate($type, $opts, $content);
 
if ($api->errorCode){
	echo "Unable to Create New Campaign!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
	echo "New Campaign ID:".$retval."\n";
}
 
?>
 

[2] xml-rpc_campaignCreate.php

<?php
/**
This Example shows how create a basic campaign using XML-RPC.
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
    $type = 'regular';
    $opts['list_id'] = $listId;
    $opts['subject'] = 'hello thar!';
    $opts['from_email'] = $my_email;
    $opts['from_name'] = 'My Name';
 
    $opts['tracking']=array('opens' => true, 'html_clicks' => true, 
                            'text_clicks' => false);
 
    $opts['authenticate'] = false;
    $opts['analytics'] = array('google'=>'atphga');
    $opts['title'] = 'My 123 Campaign';
 
    $content = array ('html'=>'something *|UNSUB|* message', 
                      'text' => 'text text text *|UNSUB|*');
 
    $seg = array();
 
    $seg['match'] = 'any';
    $seg['conditions'][] = array('field'=>'fname', 'op'=>'like', 'value'=>'bob');
 
	$result = $client->campaignCreate($apikey, $type, $opts, $content, $seg);
	echo "SUCCESS! \n";
	echo "New Campaign Id: ".$result."\n";
 
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
 
?>
 

[3] xml-rpc_campaignCreateABSplit.php

<?php
/**
This Example shows how create an A/B Split campaign using XML-RPC.
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
    $opts['list_id'] = $listId;
    $opts['subject'] = 'hello thar!';
    $opts['from_email'] = $my_email;
    $opts['from_name'] = 'My Name';
 
    $opts['tracking']=array('opens' => true, 'html_clicks' => true, 
                            'text_clicks' => false);
 
    $opts['authenticate'] = false;
    $opts['analytics'] = array('google'=>'atphga');
    $opts['title'] = 'My 123 Campaign';
 
    $content = array ('html'=>'something *|UNSUB|* message', 
                      'text' => 'text text text *|UNSUB|*');
    //no segmentation on this one.
    $seg = array();
 
    $type = "absplit";
    $type_opts = array();
    $type_opts['split_test'] = 'schedule';
    $type_opts['pick_winner'] = 'manual';
 
    $type_opts['from_name_a'] = 'Wahoo McDaniels';
    $type_opts['from_email_a'] = 'wahoo@example.org';
    $type_opts['from_name_b'] = 'Yahoo McDonald';
    $type_opts['from_email_b'] = 'yahoo@example.org';
 
	$result = $client->campaignCreate($apikey, $type, $opts, $content, $seg, $type_opts);
	echo "SUCCESS! \n";
	echo "New Campaign Id: ".$result."\n";
 
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
 
?>
 

[4] xml-rpc_campaignCreateRss.php

<?php
/**
This Example shows how create a RSS campaign using XML-RPC.
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
    $opts['list_id'] = $listId;
    $opts['subject'] = 'hello thar!';
    $opts['from_email'] = $my_email;
    $opts['from_name'] = 'My Name';
 
    $opts['tracking']=array('opens' => true, 'html_clicks' => true, 
                            'text_clicks' => false);
 
    $opts['authenticate'] = false;
    $opts['analytics'] = array('google'=>'atphga');
    $opts['title'] = 'My 123 Campaign';
 
    $content = array ('html'=>'something *|UNSUB|* message', 
                      'text' => 'text text text *|UNSUB|*');
    //no segmentation on this one.
    $seg = array();
 
    $type = 'rss';
    $type_opts = array();
    $type_opts['url'] = 'http://mailchimp.com/blog/rss';
 
	$result = $client->campaignCreate($apikey, $type, $opts, $content, $seg, $type_opts);
	echo "SUCCESS! \n";
	echo "New Campaign Id: ".$result."\n";
 
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
 
?>