Add one or more subscribers to the user's master-unsubscribe list
JSON Request Example:
/**
* Users::AddMasterUnsubscribes
*/
{
"username": "bob",
"usertoken": "abc123",
"requesttype": "Users",
"requestmethod": "AddMasterUnsubscribes",
"details": {
"email": [
"{*email_address*}", /* required: at least one */
"{*email_address*}"
]
}
}"jsonrequest" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Users |
| 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) | Email addresses 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 Quantity of contacts failed to be added to master-unsubscribe list Email address of contact added to list |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |