Return population of new and / or updated subscribers from one or more lists. User can specify a cutoff date interms of how far back to search.


JSON Request Example:   


{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Subscribers",
  "requestmethod": "GetNewSubscribers",
  "details": {
    "list": ["{*list_id*}", "{*list_id*}"], /* required: at least one */
    "date": "{*cutoff_date*}", /* required */
    "includeupdates": "{*include_updates_boolean*}",
    "customfields": ["{*customfield_name*}", "{*customfield_name*}", "all"],
    "pagination": {
      "limit": "{*max_records*}",
      "next": "{*start_at_record_number*}"
    },
    "sort": {
      "field": "{*sort_field*}",
      "direction": "{*sort_direction: asc|desc*}"
    },
    "include_membership": "{*include_membership_boolean*}"
  }
}




"json_request"


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


Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. 


"details"


Field NameDescription
list
(At least one required)
List ID of list to be searched for new or updated subscribers.
date (required)
If user wishes to include ALL subscribers since inception of the database, a safe entry to use is "2000-01-01" since this date predates the creation of any database within the Pinpointe system.
includeupdates
Use true, 1 or yes to include contacts who have been updated within the cutoff date set under <date>. Set to false, 0 or no if you do NOT want to include updated contacts.


"customfield" OPTIONAL

Add values for a subscriber's custom fields. Use one element pair per specific custom field.

NOTE: you may insert more than one pair of <customfield> tags to update multiple custom fields. 


Field NameDescription
customfieldsName of custom field to be added to returned subscriber information.  The call syntax includes a <customfield> element with the value "all". The user may delete the other <customfield> tags but retain this element if user wishes to return ALL subscriber customfields.

Please note: If no custom field data is to be returned, please delete all <customfield> tags. 
 

"pagination" OPTIONAL


Field NameDescription
limitEnter an integer to set the numerical limit for number of master-unsubscribe subscriber records that will be returned from a single call. 
nextStarting subscriber record number for a given call. If element is deleted, default is 0 (first record).


"details"

"sort" OPTIONAL


Field NameDescription
fieldID of custom field to be added. If <sort> tag deleted, system will sort by subscribers' email address. 
directionSort order of either ascending or descending. 


"include_membership" element


include_membership
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 contacts were successfully returned. 
dataFull detailed compilation of contact information per subscriber returned.


Unsuccessful Response:


"response" element


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