Example Usage of

Add new deal.

Description: Add a new deal to the system.
Endpoint: /admin/api.php?api_action=deal_add
HTTP method: POST
Supported output formats: json
Requires authentication: true
* 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
title*Title of the new deal. Example: 'Deal Title'
value*Value of the new deal in dollars. Example: '450.00' or 450
currency*Currency of the new deal. Example: 'usd'
pipeline*ID of the new deal's pipeline. Example: '3' (Get available pipeline IDs with "deal_pipeline_list" call)
stage*ID of the new deal's stage. Example: '52' (Get available stage IDs with "deal_stage_list" call)
contactidID of an existing contact for the new deal. Example: '8'. NOTE: IF THIS IS NOT PROVIDED, 'contact' MUST BE. (Get available contact IDs with "contact_list" call)
contactEmail of a new contact for the new deal. Example: '[email protected]'. NOTE: IF THIS IS NOT PROVIDED, 'contactid' MUST BE.
contact_nameName of the contact for the new deal. Example: 'John Doe'
contact_phonePhone number of the contact for the new deal. Example: '+1 312 201 0300'
customer_accountName of the organization of the contact for the new deal. Example: 'Acme Corp'
customer_acct_idID of the organization of the contact for the new deal. Example: '31'
Example response:
Variable Description
result_codeWhether or not the response was successful. Examples: 1 = yes, 0 = no
result_messageA custom message that appears explaining what happened. Example: Deal added
result_outputThe result output used. Example: json
idID of the new deal
contactID of the contact for the new deal
ownerID of the new deal's owner

PHP Example

This is an example of using the deal_add 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.


// By default, this sample code is designed to get the result from your ActiveCampaign installation and print out the result
$url = '';

// 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 adds a deal
	'api_action'   => 'deal_add',

	// define the type of output you wish to get back
	// possible values:
	// - 'json' :      data is returned in JSON format and can be decoded with
	//                 json_decode() function (included in PHP since 5.2.0)
	'api_output'   => 'json',

// here we define the data we are posting in order to perform an update
$post = array(
	'title'				=> 'My Deal Title',
	'value'             => '450',
	'currency'          => 'usd',
	'pipeline'          => '45',
	'stage'             => '23',
	'owner'             => '74',
	'contactid'         => '12',
	'contact'           => '[email protected]',
	'contact_name'      => 'John Doe',
	'contact_phone'     => '+1 312 201 0300',
	'customer_account'  => 'Acme Corp.',
	'customer_acct_id'  => '48'

// 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
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);

// 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>';
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
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>';
echo '</pre>';?>

Questions? Discuss this API call in our developer forum