Skip to main content

Working with Sitecore List Manager API (Version 9.0.1)

I've recently received a simple request to create a newsletter component. It was expected to get visitor's email, save it as contact and add it to newsletter list.

I've found couple of example while searching but they were developed for old Sitecore versions. I was searching if there is useful API provided by Sitecore.

And yes, I've found what I was looking for: The List Manager API

var subscriptionService = ServiceLocator.ServiceProvider.GetService<ISubscriptionService>();
subscriptionService.Subscribe(contactListId, contactId);

The code above seems clean and simple. But there is a problem: Where is that "ISubscriptionService"? There is no detail about which library we should use.

I had a look at some of the libraries using dotPeek and found then. It is inside Sitecore.ListManager.XConnect


This API has another useful method called "CreateSubscribedContact" to create contact but it was not suitable for my case. Because I was only had visitor's email and this was expecting some other details. So, I created contacts with another way and then added them to the list via "Subscribe" method. You can have a look at how it looks like:

public void CreateSubscribedContact(Guid listId, string identifier, string source, string firstName, string lastName, string email)
    {
      Assert.ArgumentNotNullOrEmpty(identifier, nameof (identifier));
      Assert.ArgumentNotNullOrEmpty(source, nameof (source));
      Assert.ArgumentNotNullOrEmpty(firstName, nameof (firstName));
      Assert.ArgumentNotNullOrEmpty(lastName, nameof (lastName));
      Assert.ArgumentNotNullOrEmpty(email, nameof (email));
      Assert.ArgumentCondition((listId != Guid.Empty ? 1 : 0) != 0, nameof (listId), FormattableString.Invariant(FormattableStringFactory.Create("{0} is not a valid Guid.", (object) nameof (listId))));
      this._xdbRequestPerformer.RequestWithRetry((Action<IXdbContext>) (client =>
      {
        Contact contact = client.Get<Contact>((IEntityReference<Contact>) new IdentifiedContactReference(source, identifier), (ExpandOptions) new ContactExpandOptions(new string[3]
        {
          "ListSubscriptions",
          "Personal",
          "Emails"
        }));
        if (contact == null)
        {
          contact = new Contact(new ContactIdentifier[1]
          {
            new ContactIdentifier(source, identifier, ContactIdentifierType.Known)
          });
          client.AddContact(contact);
        }
        SubscriptionService.SetPersonalFacet(firstName, lastName, contact, client);
        SubscriptionService.SetEmailFacet(email, contact, client);
        contact.SetListSubscriptionsFacet(client, listId, new Guid());
        client.Submit();
      }), "create subscribed contacts");
    }

Hope, this saves someone's time :)

Comments

Popular posts from this blog

Sitecore 9 - Custom Page Events & Filtering with XConnect

This is the first article of a series. I am going to start with creating a custom page event and will show how we can fetch event data using xconnect api. Let's start with reminding demo scenario: Imagine that you have a website displaying movies. Visitors are able to see movie details and take some actions like save movie or share it.  You want to follow the visitors' activities and you want to take some marketing actions based on those activities. For example, if a contact visits a movie more than X time or she/he saves a movie, you want to send those movies to an external system. In addition, there is going to be a limit to send same movie. Such as, it will not be possible to send same movie more than 2 times.  You want to configure this as a marketing automation plan to give flexibility to your marketing managers. They should be able to add configurable rules and activities.  My first focus is movie detail page. I want to track visitors when they visit the

A React Example in Sitecore

That's true, Sitecore components are useful and provide lots of facilities. They allow to build fully flexible website. And there is not much problem using post-backs to display your contents. However, if your website has user interactions, then it could be a headache. Too many post-backs would occur a poor user experience. That's why client-side technologies are really powerful and popular for a long time. There are plenty of javascript libraries and frameworks which all try to provide better user experience in different ways. It is not a topic of this article why I chose React. There are some good articles about it (e.g. Jonne Kats' great article ). However, one of the reasons is React only focus on view part. It is not a fully framework like Angular, it is rich featured library instead. And that's what I was looking for! The idea was to benefit Sitecore server-side and React client-side power. It seems they are very good match! Let's dive into code... I&#

Sitecore 9 - Creating Custom Segmentation Rule

Predicates are important to create rules for marketing automation and segmented lists. Before going through the details, I am going to remind what I am implementing again. Imagine that you have a website displaying movies. Visitors are able to see movie details and take some actions like save movie or share it.  You want to follow the visitors' activities and you want to take some marketing actions based on those activities. For example, if a contact visits a movie more than X time or she/he saves a movie, you want to send those movies to an external system. In addition, there is going to be a limit to send same movie. Such as, it will not be possible to send same movie more than 2 times.  According to my scenario, I need a rule to filter contacts who visits a movie more than X time. Maybe, we can add one more condition there like in Y days. To creating rule will give flexibility to marketing managers that then they can easily add or remove multiple rules and proceed the