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 :)
Labels:

Comments

Post a Comment

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 visi...
Post a Comment
Read more

Sitecore Commerce – XC9 Tips – Missing Commerce Components in SXA Toolbox on Experience Editor

I've recently had an issue that commerce components were missing in SXA Toolbox. I setup Sitecore Commerce on top of an existing instance and I already had a SXA website working on it. The idea was to add commerce components and functionality to my existing website. But after commerce setup, the toolbox was still showing default SXA components and commerce components were missing although I add commerce tenant and website modules: I checked Available Renderings under Presentation folder, there was no problem, commerce renderings were there. I created another tenant and website to see if it shows the commerce components in toolbox. Nothing seemed different but I was seeing commerce components for new website and it was missing on existing one. Then, I noticed two things: 1- Selected catalog was empty in content editor (/sitecore/Commerce/Catalog Management/Catalogs) even if I see Habitat_Master catalog in Merchandising section on commerce management panel. 2- Bootstrap ...
6 comments
Read more

Sitecore Commerce – XC9 Tips – Configuring Postman

In this post, I am going to show how to setup postman and run the scripts. When you download Sitecore Commerce, it includes ready to use postman sample requests (inside Sitecore.Commerce.Engine.SDK.x.x.x folder). You need to import that postman folder to postman app. The steps are written in official documentation , just click import and choose postman folder. You will see some parameters in sample requests such as  {{SitecoreIdServerHost}}, {{OpsApiHost}}, {{OpsApi}} Those are environment based variables that you can change according to your environment details. When you click "setting" icon, you will see predefined environments: AdventureWorks and Habitat. For example, click "Habitat Environment" to edit its variables. You see that AuthoingHost is using port 5000, it is the default port if the that port is available. You can check which port is using your Authoring role from IIS. If your Authoring port is different than 5000, you ne...
1 comment
Read more