Return population of new and / or updated subscribers from one or more lists. User can specify a cutoff date in terms 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*}"
}
}
}
"json_request"
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | GetNewSubscribers |
Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call.
"details"
| Field Name | Description |
| 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. |
| include_updates | 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 Name | Description |
| customfields | Name 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 Name | Description |
| limit | Enter an integer to set the numerical limit for number of subscriber records that will be returned from a single call. |
| next | Starting subscriber record number for a given call. If element is deleted, default is 0 (first record). |
"details"
"sort" OPTIONAL
| Field Name | Description |
| field | ID of custom field to be added. If <sort> tag deleted, system will sort by subscribers' email address. |
| direction | Sort order of either ascending or descending. |
"include_membership" element
| include_membership (optional) | 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 Name | Description |
| status | Will return SUCCESS if contacts were successfully returned. |
| data | Full detailed compilation of contact information per subscriber returned. |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |