← Back to API List

email - unsubscribeemail

This api allows you to unsubscribe an email address by adding it to the account's unsubscribe list.

API Call Information

area: email

action: unsubscribeemail

API Arguments

Argument	Data Type	Required	Description
email	string	Yes	the full email address to unsubscribe.

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=unsubscribeemail&email=example@test.com

API Response

XML Response

<response>
<status>Processed</status>
</response>

JSON Response

{
    "status": "Processed"
}