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 modifies message info based on the ID you provide
	'api_action'   => 'message_edit',

	// 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(
	'id'                       => 1, // example message ID to modify
	'format'                   => 'mime',
	// possible values:
	// - 'html'
	// - 'text'
	// - 'mime' (both html and text)

	'subject'                  => 'Email Subject',
	'fromemail'                => '[email protected]',
	'fromname'                 => 'From Name',
	'reply2'                   => '[email protected]',
	'priority'                 => '3',
	// possible values:
	// - '1' = high
	// - '3' = medium/default
	// - '5' = low

	'charset'                  => 'utf-8',
	'encoding'                 => 'quoted-printable',

	// html version
	'htmlconstructor'          => 'editor',
	// possible values:
	// - 'editor' (uses 'html' parameter)
	// - 'external' (uses 'htmlfetch' and 'htmlfetchwhen' parameters)
	// - 'upload' (uses 'message_upload_html')

	'html'                     => '<strong>html</strong> content of your email', // content of your html email
	'htmlfetch'                => 'http://somedomain.com/somepage.html', // URL where to fetch the body from
	'htmlfetchwhen'            => 'send',
	// possible values:
	// - (fetch at) 'send'
	// - (fetch) 'pers'(onalized)

	//'message_upload_html[123]' => 123, // not supported yet: an ID of an uploaded content

	// text version
	'textconstructor'          => 'editor',
	// possible values:
	// - 'editor' (uses 'text' parameter)
	// - 'external' (uses 'textfetch' and 'textfetchwhen' parameters)
	// - 'upload' (uses 'message_upload_text')

	'text'                     => '_text only_  content of your email', // content of your text only email
	'textfetch'                => 'http://somedomain.com/somepage.txt', // URL where to fetch the body from
	'textfetchwhen'            => 'send',
	// possible values:
	// - (fetch at) 'send'
	// - (fetch) 'pers'(onalized)

	//'message_upload_text[123]' => 123, // not supported yet: an ID of an uploaded content

	// assign attachments
	//'attach[123]'            => 123, // not supported yet: an ID of an uploaded file

	// assign to lists:
	'p[132]'                   => 123, // example list ID
	//'p[345]'                 => 345, // some additional lists?
	// For example, the p param after assigning the message to multiple lists:
	// $p = [
	// 	'132' => 132,
	// 	'345' => 345
	// ]
);

// 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 fetch 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, true);
// 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>';?>