API - Service group | Flexmail Email Marketing

Service: GetBlacklistUnsubscriptions

Get all contacts that got removed from the blacklist

Service Details

SOAP Action: GetBlacklistUnsubscriptions
SOAP Return Object: GetBlacklistUnsubscriptionsResp

Input

The following table describes the parameters used for calling the GetBlacklistUnsubscriptions service.

Table: instance of GetBlacklistUnsubscriptionsReq

Parameter	Mandatory	Type	Description
header	Y	APIRequestHeader	Header for authentication
from	/	DateTime	Get actions starting from this date
till	/	DateTime	Get action up untill this time
limit	/	Pagination	Limit the response to x items per page, request a certain page
order	/	Ordening	Limited to DeleteTime or EmailAddress

Output

The following table describes the parameters returned from the GetBlacklistUnsubscriptions service.

Table: instance of GetBlacklistUnsubscriptionsResp

Parameter	Mandatory	Type	Description
header	/	APIResponseHeader	Header containing authentication information
errorCode	/	Integer	Numerical value of the error
errorMessage	/	String	Short literal description of the error
unsubscriptions	/	Array of ActionlogType	Array of action log types

Table: response codes of GetBlacklistUnsubscriptionsResp.

0	No error
220	Authentication error, see header object for detailed information

Example

Get all blacklist unsubscriptions for 2018 order from most recent to least recent limited to 100 items, get page 3

<?php

// create header object
$header = new stdClass();
$header->userId = USER_ID;
$header->userToken = USER_TOKEN;

// build request
$request = new stdClass();
$request->header = $header;

// limit to 100 items per request get page 3
$request->limit = new stdClass();
$request->limit->items = 100;
$request->limit->page = 3;

// order descending by timestamp
$request->order = new stdClass();
$request->order->orderBy = 'DeleteTime';
$request->order->orderDirection = 'DESC';


// limit to year 2018
$request->from = "2018-01-01T00:00:01";
$request->till = "2018-12-31T23:59:59";

$response = $SoapClient->__soapCall("GetBlacklistUnsubscriptions", array($request));

if ($response->errorCode == 0) {
	print_r($response);
} else {
	echo "Could not get blacklist unsubscriptons" . $response->errorMessage;
}

?>