Returns the master unsubscribed subscribers for the user account. The call also allows the user to determine how many records will be returned by individual call and what record number to use to start the initial call and subsequent calls. In this way a user could set up a script to run a sequence of calls returning the first 100 contacts, the second call would return the next 100 and so forth. User may also select one of several fields by which to sort the return data.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Subscribers</requesttype>
<requestmethod>GetMasterUnsubscribes</requestmethod>
<details>
<pagination>
<limit>{*max_records*}</limit>
<next>{*start_at_record_number*}</next>
</pagination>
<sort>
<field>{*sort_field*}</field>
<direction>{*sort_direction: asc|desc*}</direction>
</sort>
</details>
<version>4.0</version>
</xmlrequest>| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | GetMasterUnsubscribes |
Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if no pagination is to be used, the <pagination> and element and its sub-elements should be deleted.
<details>
<pagination> OPTIONAL
| Field Name | Description |
| limit | Enter an integer to set the numerical limit for number of master-unsubscribe 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. |
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if contacts were successfully returned. |
| data | Record count for returned subscribers Page count <item> element for each returned subscriber:
Direction of sort Page count |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |