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 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:
You can use the following public methods to manage the subscriptions:
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 table below.
Name: |
Subscribe |
Description: |
This method adds the contact ( In addition, the contact is also removed from the default global opt-out list. Note You can extend the functionality by implementing the |
Usage: |
RequestResponseshell
|
The second public method is described in the table below.
Name: |
Unsubscribe | |
Description: |
If AddToGlobalOptOutList ( If AddToGlobalOptOutList ( If the contact could not be removed from any included contact lists or if the contact does not appear in any of the lists, the contact is instead added to the global opt-out list that is defined on the manager root. Note You can extend the functionality, if you implement the | |
Usage: |
RequestResponseshell
|
The third public method is described in the table below.
Name: |
SendAutomatedMessage | |
Description: |
This method sends an activated automated email campaign ( Note You can extend the functionality, if you implement the | |
Usage: |
RequestResponseshell
|