Unsubscribe one subscriber from a mailing list.
Note: This API call can also be found under the requesttype of "Lists".
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Subscribers</requesttype>
<requestmethod>UnsubscribeSubscriber</requestmethod>
<details>
<email>[email protected]</email> <!-- required -->
<list>123456</list> <!-- required -->
</details>
</xmlrequest><xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | UnsubscribeSubscriber |
<details> element
| Field Name | Description |
| email (Required) | Address of contact to be unsubscribed |
| list (Required) | Remove contact from the mailing list with this ID number |
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if user was successfully unsubscribed |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if call unsuccessful OR contact is not in the specified list |
| errormessage | Text explaining why request failed |