Finds if a subscriber is in a specified list.

JSON Request Example: 

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

"json_request" element

Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token for this Pinpointe account

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 NameDescription
Email address of contact to be searched for.
List id of list contact belongs to.

"include_membership" element

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 NameDescription
statusWill return SUCCESS if subscriber was successfully found in specified list

Unsuccessful Response:

"response" element

Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed