Unsubscribing from emails
The article describes possible options for unsubscribing a user from emails, and also provides information on how to check the subscription status in various ways
Unsubscribe on the product
The user can unsubscribe from emails via his personal account on the product if you provide such an opportunity. After that, you need to provide us with the user's unsubscribe information using the appropriate API points or through Sendios admin panel.
Unsubscribe via the link in the email
A link to the unsubscribe page is added to each email sent to the user.
It is not possible to unsubscribe from system emails (for example, password recovery, payment information, etc.).
You can use your own unsubscribe link or use our variables in email template to generate one. If you use your own unsubscribe link, we have no specific requirements. The options to use unsubscribe links generated on our side are described below.
The link is generated automatically and can be of 2 different types:
- {{ unsubscribeLink }} - to unsubscribe from a certain type of email. An example of such a link:
- 1575592943 - user_id
- 20948180074 - mail_id
- 03623704bb27427d2383fc7116bdfd3a - hash for a specific user.
- {{ unsubscribeSettingsLink }} - unsubscribe management page. An example of such a link:
https://n.qa.sendertest.com/unsubscribe/preferences/1575286616/18364127e276637d762070461dae1b2f?, where:
- 1575286616 - user_id
- 18364127e276637d762070461dae1b2f - hash for a specific user.
Depending on which type of link is used and from which email (system / trigger email or marketing campaign email) the user got to the unsubscribe page, the logic may vary:
Let's consider examples of unsubscribe using the link {{ unsubscribeLink }} from different types of emails.
Unsubscribe from system emails
According to legal requirements, adding an unsubscribe link to system emails is not mandatory.
If the user clicks on the unsubscribe link in the system email, this page, that opens, provides information that it is not possible to unsubscribe from system emails (such as password recovery, payment information, etc.). Therefore, we suggest the user to go to the unsubscribe management page using Preferences button:
It is not possible to unsubscribe from system emails (for example, password recovery, payment information, etc.).
Unsubscribe from trigger emails (Regular emails)
If the user clicks the unsubscribe link in the trigger email, then on the page, that opens, it is necessary to confirm his intention to unsubscribe from the trigger email type from which he opened the unsubscribe link. Also, it is possible to go to the unsubscribe management page by clicking Preferences button:
Unsubscribe from marketing campaign emails
On the page unsubscribing from marketing campaigns, the user can confirm his intention, or go to the unsubscribe management page by clicking Preferences button:
After clicking CONFIRM, the user gets to the following page:
Here the user can also go to the unsubscribe management page by clicking Preferences button:
Unsubscribe via the unsubscribe management page
As noted earlier, the following variable must be used in templates to generate a link to the unsubscribe management page {{ unsubscribeSettingsLink }}:
On this page, the user can see the categories of trigger emails from which he has already unsubscribed, as well as additionally unsubscribe from the marketing campaigns emails. Also, he can unsubscribe from all emails or vice versa - renew the subscription.
Save preferences - saves the changes made by the user;
Unsubscribe from all - unsubscribes from all the emails except the system ones. After clicking on this button, it changes to the Subscribe all button.
Unsubscribe via API endpoints
You can unsubscribe users from emails, renew their subscription, or get a list of users who are currently unsubscribed from emails using API endpoints:
- Unsubscribe - to unsubscribe users from all emails types, except system emails;
- Subscribe back - to renew the user's full subscription to emails;
- Check if unsubscribed - to check whether the user is unsubscribed from trigger emails (Regular emails);
- Unsubscribe user from types - to unsubscribe a user from a certain type of trigger emails;
- Subscribe user back to types - to renew the user's subscription to the certain type of trigger emails;
- Subscribe user back to all types - to renew the user's subscription to all types of trigger email;
- Get current unsubscribes type mails - to check if the user is unsubscribed from certain types of trigger emails.
Also, you can get additional information about subscriptions using API endpoints:
- Get unsubscribed list - to get a list of unsubscribed users on the specified date;
- Get unsubscribe reason - to check the reason why the user is unsubscribed from mailings.
Unsubscribe for other reasons
In some cases, we can unsubscribe the user from our side for some reasons, for example:
- invalid user email address;
- invalid mail domain;
- non-existent user email address;
- overflowing user email inbox, etc.
In such cases, we unsubscribe the user from receiving emails from our side not to diminish the reputation of the mail domain.
Unsubscribe via Sendios admin panel
By going to user page in the admin panel, you can unsubscribe the user from trigger emails and / or marketing campaigns or, on the contrary, renew the subscription.
- Subscribe / unsubscribe regular emails - to unsubscribe the user / renew the subscription to trigger emails;
- Subscribe / unsubscribe marketing campaigns - to unsubscribe the user / renew the subscription to marketing campaigns.
You can find out more in User Guide - User Profile article.
How to find out if the user is unsubscribed and check the reason?
You can find out about a user's unsubscribe using API endpoints Check if unsubscribed (which corresponds to the information displayed in the Unsubscribe types field in the admin panel as shown below) and Get current unsubscribes type mails (corresponds to the Unsubscribe regular emails field in the admin panel) or in the Sendios admin panel as described below.
You can check the reason for unsubscribe using:
- API endpoint Get unsubscribe reason;
- Sendios admin panel in the User section - Unsubscribes - Reason field:
In the same section, you can see if the user is unsubscribed from any mailings (certain types of emails, trigger emails or marketing campaigns), unsubscribe the user, and renew the subscription if currently unsubscribed from emails. You can find out more in User Guide - User Profile article.
Description of user unsubscribe codes and corresponding reasons
Among the possible unsubscribe codes that can be displayed in the Sendios admin panel in the User section, there're the following:
| Source ID | Unsubscribe code name | Unsubscribe reason |
|---|---|---|
| 2 | FBL | Complaint about the email from the user, which was submitted through the vendor |
| 5 | LIST_HEADER | Unsubscribe using the email's header |
| 8 | CLIENT_CALLBACK | 1. The customer has deleted the user account from the product at user's request; 2. The client archived the user account (after N days after the last activity on the product/or N days after registration, if there was no activity at all) |
| 9 | SETTINGS_TYPES | The user has completely unsubscribed from the emails in the settings in his personal account on the product (removed all the ticks) |
| 10 | INVALID | The user was unsubscribed due to an invalid or non-existent email (most often it happens when sending the first email to the user) |
| 15 | DISTANCE_BOUNCE | The user was unsubscribed due to an overflowing user email inbox or the email was blocked by the vendor |
| 16 | ADMIN | Unsubscribe via the Sendios admin panel |
| 18 | SETTINGS_ONECLICK | Full unsubscribe in one click (currently deprecated, but you may come across for older unsubscribes) |
| 19 | PAGE | Unsubscribe via the link in the email |
Updated 27 days ago