Developers

<?php

// By default, this sample code is designed to get the result from your ActiveCampaign installation and print out the result
$url = 'https://account.api-us1.com';

// the API Key can be found on the "Your Settings" page under the "API" tab.
// replace this with your API Key
$api_key = 'YOUR_API_KEY';

$params = array(

	// this is the action that creates a campaign
	'api_action'   => 'campaign_create',

	// define the type of output you wish to get back
	// possible values:
	// - 'xml'  :      you have to write your own XML parser
	// - 'json' :      data is returned in JSON format and can be decoded with
	//                 json_decode() function (included in PHP since 5.2.0)
	// - 'serialize' : data is returned in a serialized format and can be decoded with
	//                 a native unserialize() function
	'api_output'   => 'serialize',
);

// here we define the data we are posting in order to perform an update
$post = array(
	// campaign type (defaults to single)
	'type'						=> 'single',
	// possible values:
	// - 'single'
	// - 'recurring'
	// - 'split'
	// - 'responder'
	// - 'reminder'
	// - 'activerss'
	// - 'text'

	// use list segment with ID (0 for no segment)
	'segmentid'					=> 0,

	'name'						=> 'ActiveCampaign TEST: ' . date("m/d/Y H:i", strtotime("now")),

	// the date when campaign should be sent out
	// not used for 'responder', 'reminder'
	'sdate'						=> '2011-10-05 08:40:00',

	'status'					=> 1,
	// possible values:
	// - 0: draft
	// - 1: scheduled

	// if campaign should be visible via public side
	'public'					=> 1,
	// possible values:
	// - 1: visible
	// - 0: not visible

	// 'tracklinks'				=> 'all',
	// setting this value to all will let the system know to fetch, parse, and track all emails it finds in both TEXT
	// and HTML body
	// if mime/html/text is provided, then variable 'links' also must exist, with a list of URLs to track
	// choosing html or text will track only the links in that message body
	// possible values:
	// - 'all'
	// - 'mime'
	// - 'html'
	// - 'text'
	// - 'none'

	// set to 1 if you wish to use list's Google Analytics settings
	// 'tracklinksanalytics'     	=> 1,

	// set the name of this campaign to use in Google Analytics
	// 'analytics_campaign_name' 	=> '',

	'trackreads'				=> 1,

	'trackreplies'				=> 0,

	// set to 1 if you wish to use list's Twitter settings
	// 'tweet'                   	=> 1,

	// set to 1 if you wish to use list's Facebook settings
	// 'facebook'                	=> 1,

	// uncomment this line if you wish to embed images
	// 'embed_images'            	=> 1,

	// append unsubscribe link to the bottom of HTML body
	'htmlunsub'					=> 1,

	// append unsubscribe link to the bottom of TEXT body
	'textunsub'					=> 1,
	// If you don't add an unsub link to your message it will be added
	// automatically regardless of whether this is set or not

	// provide custom unsubscribe link addons
	// 'htmlunsubdata'	=> '<div><a href="%UNSUBSCRIBELINK%">Click here</a> to unsubscribe from future mailings.</div>',

	// 'textunsubdata'				=> 'Click here to unsubscribe from future mailings: %UNSUBSCRIBELINK%',

	/* IF RECURRING MAILING */
	// values ending with 1 mean "every", and ending with 2 mean "every other"
	// 'recurring'               	=> 'day1', // repeat every day
	// possible values:
	// - day1
	// - day2
	// - week1
	// - week2
	// - month1
	// - month2
	// - quarter1
	// - quarter2
	// - year1
	// - year2

	/* IF SPLIT MAILING */
	// 'split_type'              	=> 'even',
	// if read or click is used, 'split_offset' and 'split_offset_type' need to be present.
	// in that case it will use a "winner" scenario
	// send each message to even number of contacts
	// possible values:
	// - even
	// - read
	// - click

	// how much to wait
	// 'split_offset'            	=> 12,

	// how long to wait.
	// 'split_offset_type'       	=> 'hour',
	// possible values:
	// - hour
	// - day
	// - week
	// - month

	/* IF AUTO-RESPONDER */
	// how long after (un)subscription to send it
	// 'responder_offset'        	=> 12,

	// after what to send it.
	// 'responder_type'          	=> 'subscribe',
	// possible values:
	// - subscribe
	// - unsubscribe

	/* IF AUTO-REMINDER */
	// what contact field to use.
	// 'reminder_field'          	=> 12,
	// possible values:
	// - cdate
	// - sdate
	// - udate
	// - ID of a custom field that must be a date type

	// format in which the date is represented in abovementioned contact field
	// 'reminder_format'         	=> 'yyyy-mm-dd',

	// match just a month and the day (yearly), or match year as well.
	// 'reminder_type'           	=> 'month_day',
	// possible values:
	// - month_day
	// - year_month_day

	// how many days/weeks/months/years from that date should it trigger
	// 'reminder_offset'         	=> 5,

	// 'reminder_offset_type'    	=> 'day',
	// possible values:
	// - day
	// - week
	// - month
	// - year

	// 'reminder_offset_sign'    	=> '+',
	// in this case it would be: +5 days from today needs to be the value of contact's field
	// possible values:
	// - +
	// - -.

	/* IF ACTIVERSS */
	// same options as for recurring mailings
	// 'activerss_interval'      	=> 'day1',

	// send to lists:
	'p[1]'						=> 1, // example list ID
	// 'p[1]'                    	=> 345, // some additional lists?

	// send message(s):
	'm[70]'						=> 100, // example message ID would be 70. 100 means send to 100% of contacts

	/* IF SPLIT MAILING */
	// if sending a split mailing with "winner" scenario, more than one message can be provided.
	// in that case, the sum of all messages should total to under 100%
	// (so the rest of contacts can receive a winner message after it is determined)
	// 'm[453643]'              	=> 10, // some additional messages?
	// 'm[346146]'              	=> 10, // some additional messages?

	// 'addressid' 					=> 0, // Address ID (0 for default).


	// if 'tracklinks' variable is not set to 'all', provide a list of links to track here

	// tracked link example
	// 'linkurl[0]'              	=> 'http://www.google.com/',
	// 'linkname[0]'             	=> 'Google Inc.',
	// 'linkmessage[0]'          	=> 123, // found in message with this ID

	// more tracked links...
	// 'linkurl[1]'              	=> 'http://www.yahoo.com/',
	// 'linkname[1]'             	=> 'Yahoo Inc.',
	// 'linkmessage[1]'          	=> 345, // found in message with this ID
);

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// This section takes the input data and converts it to the proper format
$data = "";
foreach( $post as $key => $value ) $data .= urlencode($key) . '=' . urlencode($value) . '&';
$data = rtrim($data, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
	die('JSON not supported. (introduced in PHP 5.2.0)');
}

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HTTPHEADER, array('API-TOKEN: ' . $api_key));  //  Provide the API Token via the API-TOKEN header
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
curl_setopt($request, CURLOPT_POSTFIELDS, $data); // use HTTP POST to send form data
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);

$response = (string)curl_exec($request); // execute curl post and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object

if ( !$response ) {
	die('Nothing was returned. Do you have a connection to Email Marketing server?');
}

// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';

// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';

// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;

echo '<br /><br />POST params:<br />';
echo '<pre>';
print_r($post);
echo '</pre>';?>