Search for subscribers in a mailing list and retrieve their email addresses.


XML Request Example:       

<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
   <username>sleung</username>
   <usertoken>3ae9291d3b1e08ed1d762dc1e74d71a51406f341</usertoken>
   <requesttype>lists</requesttype>
   <requestmethod>GetListSubscribers</requestmethod>
   <details>
       <list>10242</list>
       <status>active</status>
   </details>
</xmlrequest>

 <xmlrequest> element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeName of API set to be used
requestmethodFunction being called


Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if no second <list> value or <status> value will be supplied, these empty tags should be removed. 


<details> element


Field NameDescription
list
(Required)
ID of contact list to be searched
list
(Optional)
Additional contact lists to be searched               
statusStatus of contacts to be searched for. Default value if no status value
given is "any".



Successful Response Example:



 

Successful Response:


<response> element


Field NameDescription
statusWill return SUCCESS if contacts were successfully found
dataContact ID number


Unsuccessful Response:


<response> element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed