Search for subscribers in a segment and retrieve their email addresses.



XML Request Example:    

<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
  <username>JohnDoe</username>
  <usertoken>abc123abc123abc123abc123</usertoken>
  <requesttype>Segments</requesttype>
  <requestmethod>GetSegmentSubscribers</requestmethod>
  <details>
    <segmentid>{*segment_id*}</segmentid> <!-- required -->
    <segmentid>{*segment_id*}</segmentid>
    <status>{*status: any|active|inactive|bounced|unsubscribed*}</status>
    <include_membership>{*include_membership_boolean*}</include_membership>
  </details>
</xmlrequest>


XML

 <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 only one segmentid is being searched, remove all unused <segmentid></segmentid> elements.


<details> element

<tag>


Field NameDescription
segmentid
(Required)
ID of segment to be searched. At least one required.  
status
Select from the options provided to search for contacts with that status.
Will default to "all".


"include_membership" element


include_membership
PieSync requirement: Setting this element's value to true, 1 or yes results in the API call adding a list of all tags that a subscriber is in as part of the returned information for that subscriber.


Successful Response:


<response> element


Field NameDescription
statusWill return SUCCESS if contacts were successfully found.
dataContact count, status selected, subscriber details.


Unsuccessful Response:


<response> element


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