Add one or more subscribers to the user's master-unsubscribe list
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?> <xmlrequest> <username>JohnDoe</username> <usertoken>abc123abc123abc123abc123</usertoken> <requesttype>Subscribers</requesttype> <requestmethod>AddMasterUnsubscribes</requestmethod> <details> <email>{*email_address*}</email> <!-- required: at least one --> <email>{*email_address*}</email> </details> <version>4.0</version> </xmlrequest>
<xmlrequest> element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Subscribers |
requestmethod | AddMasterUnsubscribes |
Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if only one subscriber is to be added to the master-unsubscribe list, the second <email></email> tag pair should be deleted.
<details> element
Field Name | Description |
email (at least one required) | Contact(s) to be added to the master-unsubscribe list. |
Successful Response:
<response> element
Field Name | Description |
status | Will return SUCCESS if contact(s) was / were successfully added to master-unsubscribe list |
data | Quantity of contacts added to master-unsubscribe list Email of contact added to list |
Unsuccessful Response:
<response> element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |