Mailchimp API

Unsubscribe the given email address from the list

Section:

List Related

Parameters:

apikey

a valid API Key for your user account. Get by visiting your API dashboard

id	the list id to connect to. Get by calling lists()

email_address

the email address to unsubscribe OR the email "id" returned from listMemberInfo, Webhooks, and Campaigns

delete_member

flag to completely delete the member from your list instead of just unsubscribing, default to false

send_goodbye

flag to send the goodbye email to the email address, defaults to true

send_notify

flag to send the unsubscribe notification email to the address defined in the list email notification settings, defaults to true

Returns:

boolean   -  true on success, false on failure. When using MCAPI.class.php, the value can be tested and error messages pulled from the MCAPI object (see below)

Examples (2)

download example code

[1] mcapi_listUnsubscribe.php

<?php
/**
This Example shows how to pull the Info for a Member of a List using the MCAPI.php 
class and do some basic error checking.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$retval = $api->listUnsubscribe( $listId,$my_email);
if ($api->errorCode){
    echo "Unable to load listUnsubscribe()!\n";
	echo "\tCode=".$api->errorCode."\n";
	echo "\tMsg=".$api->errorMessage."\n";
} else {
    echo "Returned: ".$retval."\n";
}
 
 

[2] xml-rpc_listUnsubscribe.php

<?php
/**
This Example shows how to Unsubscribe a member from a List using XML-RPC.
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
	$result = $client->listUnsubscribe($apikey, $listId, $my_email,false, false, false);
	echo "SUCCESS!\n";
	echo "Returned: ".$result."\n";
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
?>