Get all unsubscribed email addresses for a given campaign
Signature
public function campaignUnsubscribes(string
$cid,
[integer
$start = 0,
[integer
$limit = 1000]] )
Parameters
$cid
—
string
the campaign id to pull bounces for (can be gathered using campaigns())
$start
—
integer
optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
$limit
—
integer
optional for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000
Returns
array
a total of all unsubscribed emails and the specific emails for this page int total the total number of unsubscribes for the campaign
array data the full email addresses that unsubscribed
string email the email address that unsubscribed
string reason For unsubscribes only - the reason collected for the unsubscribe. If populated, one of 'NORMAL','NOSIGNUP','INAPPROPRIATE','SPAM','OTHER'
string reason_text For unsubscribes only - if the reason is OTHER, the text entered.