Frontend API

To interact with Newsletter Studio from the front end we provide a very simple API in the static class NewsletterStudio.Api. This class has several methods for adding and removing subscribers both from the built in subscriptions and from Umbraco's member section (it won't delete anything but it changes property values).

public static bool IsValidEmail(string email)
Helper that checks if a string contains a valid e-mail address

public static bool Subscribe(string email)
Adds a subscriber with only email to the default mailing list

public static bool Subscribe(string email, string name)
Adds a subscriber with email and name to the default mailing list.

public static bool Subscribe(string email, int mailinglistId)
Adds a subscriber with only email to a given mailing list. Works only with the default mailing lists in Newsletter Studio.

public static bool Subscribe(string email, string name, int mailinglistId)
Adds a new subscriber to a given mailing list. Works only with the default mailing lists in Newsletter Studio.

public static bool UnSubscribe(string email, string subscriptionAlias)
Unsubscribe an email from a given mailing list based on the subscription alias.

The subscription alias is build up using:
1. The unique name of the provider and
2. The data provider key for the list item.

Example: "NewsletterStudioSubscriptionProvider_1" would be the Newsletter Studio Subscription Provider (for built in Mailing Lists) and the list with id 1. Have a look in the "newsletter" table in the database to see more examples of subscription aliases.

NOTE: Passing an empty string as subscriptionAlias will unsubscribe the email from all lists in all providers.

public static bool UnSubscribe(string email)
(Only in versions about 2.1.9.8) Unsubscribe an email from all lists in all Subscription Providers.

Examples

// Add to first list
NewsletterStudio.Api.Subscribe("email@site.com");

// Add to specific list (by id)
NewsletterStudio.Api.Subscribe("email@site.com",7);

// Add to specific list, set name
NewsletterStudio.Api.Subscribe("email@site.com","John Doe",3);

// Unsubscribe from MailingList with id 1
NewsletterStudio.Api.UnSubscribe("email@site.com", "NewsletterStudioSubscriptionProvider_1");

// Unsubscribe from ALL lists (passing empty string as subscriptionAlias)
NewsletterStudio.Api.UnSubscribe("email@site.com", "");