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.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?> <xmlrequest> <username>JohnDoe</username> <usertoken>abc123abc123abc123abc123</usertoken> <requesttype>Lists</requesttype> <requestmethod>GetLists</requestmethod> <details> </details> </xmlrequest>
<xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Lists |
| requestmethod | GetLists |
| details | This empty element is required but no input required from user |
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 |
| 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 |