Returns ID numbers and statistics for all mailing lists. Statistics include number of subscribers, number of contacts who have unsubscribed, and number of contacts who have bounced.
JSON Request Example:
{
"username": "DRBrel2",
"usertoken": "25cdc94232a34e752e150ca278e980d0416a390f",
"requesttype": "Lists",
"requestmethod": "GetLists",
"details": {
/* no parameters */
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Lists |
| requestmethod | GetLists |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if lists found for the user name supplied |
"response"
"data"
"item" element - One will be returned for each contact list
| Field Name | Description |
| ownerid | Account owner ID |
| ownername | Account owner contact name |
| owneremail | Account owner email address |
| listid | ID number for list |
| name | Descriptive name for list |
| description | List description if present |
| createdate | The create date timestamp |
| deletedate | The delete date timestamp |
| subscribecount | Number of contacts subscribed to list |
| unsubscribecount | Number of unsubscribed contacts for list |
| bouncecount | Number of bounced contacts for list |
| username | Username for account |
| fullname | Username for account |
| sendfrom | send-from email address for each respective list presented |
| totalcount | Total count for all subscribers in list regardless of status |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED when unsuccessful |
| errormessage | Text explaining why request failed |