function MCAPI::campaignUnsubscribes in Mailchimp 6.2
Same name and namespace in other branches
- 5.2 MCAPI.class.php \MCAPI::campaignUnsubscribes()
- 5 MCAPI.class.php \MCAPI::campaignUnsubscribes()
- 6 MCAPI.class.php \MCAPI::campaignUnsubscribes()
- 7 MCAPI.class.php \MCAPI::campaignUnsubscribes()
Get all unsubscribed email addresses for a given campaign
Stats
Parameters
string $cid the campaign id to pull bounces for (can be gathered using campaigns()):
integer $start optional for large data sets, the page number to start at - defaults to 1st page of data (page 0):
integer $limit optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000:
Return value
array list of email addresses that unsubscribed from this campaign
File
- ./
MCAPI.class.php, line 608
Class
Code
function campaignUnsubscribes($cid, $start = 0, $limit = 1000) {
$params = array();
$params["cid"] = $cid;
$params["start"] = $start;
$params["limit"] = $limit;
return $this
->callServer("campaignUnsubscribes", $params);
}