Developers

Example Usage of
branding_edit

Update Design/Branding settings for User Groups.

Description: Allows you to modify Design/Branding settings for a particular User Group, such as site name, logo location, and HTML/CSS templates for the public and admin sections of the software.
Endpoint: /admin/api.php?api_action=branding_edit
HTTP method: POST
Supported output formats: xml, json, serialize
Requires authentication: true
Parameters:
* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/x-www-form-urlencoded
. We don't accept any other input formats like JSON.
Variable Description
api_action*branding_edit
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
site_nameTitle of software. Example: 'ActiveCampaign Email Marketing'
design_urlURL of logo. Large logos appear on the login page.
design_url_smallURL of small logo. Small logos appear in the header of the admin panel.
branding_header_html_valContent of non-removable header. Example: <p>header content here</p>
branding_footer_html_valContent of non-removeable footer. Example: <p>footer content here</p>
header_text_valueContent of non-removable header. Example: text header content
footer_text_valueContent of non-removeable footer. Example: text footer content
linksExternal links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value.
admin_templateThe actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)
admin_styleThe actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)
public_templateThe actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)
public_styleThe actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)
Example response:
Variable Description
result_codeWhether or not the request was successful. Examples: 1 = yes, 0 = no
result_messageA custom message that appears explaining what happened. Example: Design Settings updated
result_outputThe result output used. Example: serialize

PHP Example

This is an example of using the branding_edit call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using serialize as the output format. You can change that to XML or JSON if you would like.

<?php

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


$params = array(

	// 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',

	// this is the action that modifies group info based on the ID you provide
	'api_action'   => 'branding_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(
	'site_name' => 'ActiveCampaign Email Marketing', // Title of software. Example: 'ActiveCampaign Email Marketing'
	'design_url' => 'http://mysite.com/logo.jpg', // URL of logo. Large logos appear on the login page.
	'design_url_small' => 'http://mysite.com/logo_small.jpg', // URL of small logo. Small logos appear in the header of the admin panel.
	'branding_header_html_val' => '<p>my custom HTML header</p>', // Content of non-removable header. Example: <p>header content here</p>
	'branding_footer_html_val' => '<p>my custom HTML footer</p>', // Content of non-removeable footer. Example: <p>footer content here</p>
	'header_text_value' => 'my custom text header', // Content of non-removable header. Example: text header content
	'footer_text_value' => 'my custom text footer', // Content of non-removeable footer. Example: text footer content
	'links' => 'on', // External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value.
	'admin_template' => '', // The actual HTML template
	'admin_style' => '', // The actual CSS. Example: test { color: green; }
	'public_template' => '', // The actual HTML template
	'public_style' => '', // The actual CSS. Example: test { color: green; }
);

// 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_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>';?>

Questions? Discuss this API call in our developer forum