List Unsubscribers

 Home /Knowledgebase / SEMSblast API /List Unsubscribers

Use the API to retreive unsubscribers for a whole account or a group.
 

Request

Submit an XML Request with the following details:

Post URL: http://cp.semsblast.com/api/v3.0/subscribers/listUnsubscribers/

 

Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.
groupID Int Optional The ID of the group you would like to request subscribers from.
startDate DateTime Optional yyyy-mm-dd - The date you would like to start searching from
endDate DateTime Optional yyyy-mm-dd - The date you would to to stop searching from.

 

Response

Data Sent Back
error Int Indicates wether an error has occured. 0 for no error. 1 for error.
status String If there's been an error, a text description of the error that occured will be here.
unsubscriberCnt Int The number of un subscribers returned.
unsubscribers    
---> unsubscriber    
--------> subscriberID Int The ID of the subscriber.
--------> campaignID Int The ID of the campaign that the user unsubscribed from.
--------> firstName String The first name of the subscriber.
--------> lastName String The last name of the subscriber.
--------> companyName String The company name of the subscriber.
--------> email String The email address of the subscriber.
--------> dateUnsubscribed Date Time The date the subscriber unsubscribed

 

Sample request XML

<xml>
     <apiKey>44-121312131223</apiKey>
     <groupID>123</groupID>
     <startDate>2014-01-01</startDate>
     <endDate>2015-01-01</endDate>
</xml>

 

Sample response XML

<xml>
     <error>0</error>
     <status>success</status>
     <unsubscriberCnt>1</unsubscriberCnt>
     <unsubscribers>
          <unsubscriber>
               <subscriberID>1311</subscriberID>
               <campaignID>3213</campaignID>
               <firstName>Test</firstName>
               <lastName>User</lastName>
               <companyName>Test Co</companyName>
               <email>test@test.com</email>
               <dateUnsubscribed>2014-01-01 11:37</dateUnsubscribed>
          </unsubscriber>
     </unsubscribers>
</xml>





Copyright © 2015 SEMSblast.com | Smarter eMail Marketing Solution. All rights reserved.Terms of Service | Privacy Policy