Search for subscribers in a segment and retrieve their email addresses.
JSON Request Example:
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Segments |
requestmethod | GetSegmentSubscribers |
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
Field Name | Description |
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 Name | Description |
status | Will return SUCCESS if contacts were successfully found. |
data | Contact count, status selected, subscriber details. |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |