The Email Experience Manager Client API

The Email Experience Manager ClientAPIService class, Sitecore.EmailCampaign.Cd.Services.ClientAPIService, is used by EXM to handle subscribes and unsubscribes. You can use it to manage subscriptions to lists in the List Manager and send automated email messages.

The Email Experience Manager Client API (ClientApiService ) is registered in the IOC container, so you can either inject it into the constructor of your class or you can use the ServiceLocator, for example:

IClientApiService _clientApiService;public MyConstructor(IClientApiService clientApiService)
{
  _clientApiService = clientApiService;
}

or

IClientApiService clientApiService = ServiceLocator.ServiceProvider.GetService< IClientApiService >()

The ClientAPIService API is only registered on the CD role. And the CD server is not configured to add or remove contacts from a List Manager list, or to send EXM campaigns. Therefore, if you’re working in a scaled server setup, you must use the ClientAPIService request to delegate that work to the CM servers.

The following diagram depicts this process:

The following public methods are available on the IClientApiService:

• SendAutomatedMessage
• UpdateListSubscription

These methods use a ContactIdentifier to identify the contact that you want to do the operation. For more information, see Contact identifiers and Identifying contacts.

The first public method is described in the following table.

• Name:: SendAutomatedMessage
• Description:: This method sends an activated automated email campaign (automatedMessage.MessageId) to the contact (automatedMessage.ContactIdentifier) with the option to specify a set of custom tokens and the target language, as well as a set of custom query string parameters that are used when rendering the email campaign during dispatch.You can extend the AutomatedMessage class using the CustomQueryStringParameters property so that additional query string parameters are supported (for example, IDictionary<string, string> CustomQueryStringParameters).The WebPageMail body link is generated in the GenerateBodyLink pipeline. This pipeline is executed during the email dispatch when EXM generates the link to download the email campaign contents. The pipeline generates the base URL, adds default query string parameters, and then adds custom query string parameters. For example
  code injected inside the .cshtml for this example looks like this:

http://XXXX/?sc_itemid=XXX&sc_lang=XXX&sc_pd_view=XXX&yourParam=someValue&
ec_eq=XXX

@{
	string customQueryString = Request.Params["yourParam"];
	if (!string.IsNullOrWhiteSpace(customQueryString))
	{
		<div class="customquerystringparameters">@MvcHtmlString.Create(customQueryString)</div>
	}
}

• Usage::

void SendAutomatedMessage(AutomatedMessage automatedMessage)

The second public method is described in the table below.