PLEASE NOTE: THIS CALL FUNCTIONALITY WAS PREVIOUSLY PROVIDED VIA IsSubscriberlOnList, WHICH HAS BEEN DEPRECATED. USERS SHOULD USE IsEmailOnList.
Determine whether a contact is in a mailing list by checking their email address.
JSON Request Example:
/**
* Lists::IsEmailOnList
*/
{
"username": "bob",
"usertoken": "abc123",
"requesttype": "Lists",
"requestmethod": "IsEmailOnList",
"details": {
"email": "{*email_address*}", /* required */
"list": "{*list_id*}" /* required */
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Lists |
| 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 email address was successfully found |
| data | Will return subscriber ID if found |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return Failed if unsuccessful |
| error message | Text explaining why request failed |