Get Newsletter Receivers

apiGetNewsletterReceivers

Use this function to retrieve all receiversĀ of a certain campaign.

Request

NameTypeExampleRequiredComment
newsletterIDInteger5
startInteger5
countInteger100Max value for this one is 10 000

Response

stdClass Object
(
[newsletterReceiversResponse] => Array
        (
            [0] => stdClass Object
                (
                    [subscriberID] => 12
                    [subscriberEmail] => myemail1@example.com
                    [subscriberBounceStatus] => false
                )
            [1] => stdClass Object
                (
                    [subscriberID] => 13
                    [subscriberEmail] => myemail2@example.com
                    [subscriberBounceStatus] => hb
                )
            [2] => stdClass Object
                (
                    [subscriberID] => 14
                    [subscriberEmail] => myemail3@example.com
                    [subscriberBounceStatus] => sb
                )
         [...]
      )
)

Error Response

CodeInterpretation
404No receivers are found

PHP5 Example

try {
   $request = array(
         'newsletterID' => 100
         'start'=>0,
         'count'=>10
   );
   $response = $client->apiGetNewsletterReceivers($request);
}