Global Suppressions List

This guide explains how to manage the global suppression list, which tracks customers who have opted out of receiving marketing communications.

---

Automatic Opt-Out

When a customer reports an email sent from the platform as spam, they are automatically added to the global suppression list. This means they will be opted out from all marketing emails effectively immediately to protect your sender reputation.

Manual Opt-Out

You can manage a customer’s presence on the global suppression list either through the backend interface or programmatically via the API.

From the Backend

To manage a customer’s opt-out status manually:

1. Navigate to the customer’s profile.
2. Go to the Social Channels tab.
3. Locate the option “Opt-out from all marketing lists”.
   • Check the box to add the customer to the global suppression list.
   • Uncheck the box to remove them.

Alternatively, you can use the “Clear optouts” button on this tab. This action clears all opt-outs for that customer across all channels, including the global suppression list.

Via the API

You can also manage opt-outs using the Customer Preference API endpoints.

To opt out a customer:

Send a customer-authenticated HTTP POST request to /cms/customer/preference with the following JSON body:

{
  "optout_marketing": "1",
  "optout_marketing_date": "yyyy-mm-dd hh:mm:ss"
}

To clear an opt-out:

Send an HTTP DELETE request to /cms/customer/preference/optout_marketing.

For more detailed information, please refer to the API documentation.

Viewing the Global Suppression List

To view all customers who are currently on the global suppression list:

1. Navigate to Revenue -> Customers.
2. Open the Filters panel.
3. Add the filter “Marketing optout”.
4. Keep the default operator setting as “Is set / not empty”.

This will display a list of all customers who have opted out of marketing communications.