This API call has been deprecated. User should use IsEmailOnList.
Determine whether a contact has unsubscribed from a list by checking their email address.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?> <xmlrequest> <username>JohnDoe</username> <usertoken>abc123abc123abc123abc123</usertoken> <requesttype>Lists</requesttype> <requestmethod>IsUnsubscriber</requestmethod> <details> <email>john.doe@pinpointe.com</email> <!-- required --> <list>4</list> <!-- required --> </details> </xmlrequest>
<xmlrequest> element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Lists |
requestmethod | IsUnsubscriber |
<details> element
Field Name | Description |
email (Required) | email address of contact list to be searched for |
list (Required) | list id of list to be searched |
Successful Response:
<response> element
Field Name | Description |
status | Will return SUCCESS if user is unsubscribed |
data | Will return 1 if contact unsubscribed |
Unsuccessful Response:
<response> element
Field Name | Description |
status | Will return FAILED if call is unsuccessful. Will also return FAILED if contact is found on list BUT is not unsubscribed. |
errormessage | Text explaining why request failed saying contact is |