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


JSON Request Example:    

{
  "username": "DRB-Test",
  "usertoken": "a1de7f1e68e24201ad22a0cb166eee90c969237e",
  "requesttype": "Segments",
  "requestmethod": "GetSegmentSubscribers",
  "details": {
    "segmentid": ["{*segment_id*}", "{*segment_id*}"], /* at least one segment id required */
    "status": "{*status: any|active|inactive|bounced|unsubscribed*}",
    "include_membership": "{*include_membership_boolean*}"
  }
 } 


"json_request" 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 "{*segment_id*}" elements.


"details" element


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.


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