Finds if a subscriber is in a specified list.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?> <xmlrequest> <username>JohnDoe</username> <usertoken>abc123abc123abc123abc123</usertoken> <requesttype>Subscribers</requesttype> <requestmethod>FindSubscriber</requestmethod> <details> <email>dboyd@pinpointe.com</email> <!-- required --> <list>6469</list> <!-- required --> <include_membership>0</include_membership> </details> <version>4.0</version> </xmlrequest>
<xmlrequest> element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token for this Pinpointe account |
requesttype | Subscribers |
requestmethod | FindSubscriber |
Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if <include_membership> element not required, the tag pair should be deleted OR a value of"false", "0" or "no" entered in as a value.
<details> element
Field Name | Description |
email (Required) | Email address of contact to be searched for. |
list (Required) | List id of list contact belongs to. |
<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 subscriber was successfully found in specified list |
Unsuccessful Response:
<response> element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |