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:     

{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Subscribers",
  "requestmethod": "IsEmailOnList",
  "details": {
    "email": "{*email_address*}", /* required */
    "list": "{*list_id*}" /* required */
  }
}
Null

 "json_request"  element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeSubscribers
requestmethodIsEmailOnList


"details" element


Field NameDescription
email (Required)Email address of contact to be located
list (Required)ID of list to search for contact


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if email address was successfully found
dataWill return subscriber ID if found


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return Failed if unsuccessful
error messageText explaining why request failed