Developers

Example Usage of
automation_contact_remove

Remove contact from automation

Description: Remove a contact from an automation they were already added to.
Endpoint: /admin/api.php?api_action=automation_contact_remove
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*automation_contact_remove
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
contact_id*The ID of the contact you want to have removed from the automation (either this or contact_email is required)
contact_email*The email address of the contact you want to have removed from the automation (either this or contact_id is required)
automation*The automation ID (only one allowed) to remove the contact from
Example response:
Variable Description
result_code1
result_messageContact removed from automation
result_outputserialize

PHP Example

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

// Set up an object instance using our PHP API wrapper.
define("ACTIVECAMPAIGN_URL", "https://{ACCOUNT}.api-us1.com");
define("ACTIVECAMPAIGN_API_KEY", "{API_KEY}");
require_once("../activecampaign-api-php/includes/ActiveCampaign.class.php");
$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);

$post_data = array(
	"contact_email" => "abc@def.com", // include this or contact_id
	"automation" => "5",
);
$response = $ac->api("automation/contact/remove", $post_data);

echo "<pre>";
print_r($response);
echo "</pre>";?>

Questions? Discuss this API call in our developer forum