PLEASE NOTE: THIS CALL FUNCTIONALITY WAS PREVIOUSLY PROVIDED VIA IsSubscriberlOnList, WHICH HAS BEEN DEPRECATED. USERS SHOULD USE IsEmailOnList.
Note: This API call can also be found under the requesttype of "Lists".
Determine whether a contact is in a mailing list by checking their email address.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Subscribers</requesttype>
<requestmethod>IsEmailOnList</requestmethod>
<details>
<email>[email protected]</email> <!-- required -->
<list>123456</list> <!-- required -->
</details>
</xmlrequest><xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | IsEmailOnList |
<details> element
| Field Name | Description |
| email (Required) | Email address of contact to be located |
| list (Required) | ID of list to search for contact |
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if user was successfully found |
| data | Will return subscriber ID if found Will return subscriber ID of "0" if call successful but the contact's email address is NOT found in the specified list. |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return Failed if unsuccessful |
| error message | Text explaining why request failed |