Recipient List API

2025/08/25 5:06 PM

In a site I'm working on, we'll be using recipient lists to manage subscriber lists to various groups of marketing newsletters.

Is there an API for manipulating which emails are in a recipient list? I wasn't able to find much in the way of documentation on this, just the below classes, which don't look like they hold what I'm looking for.

https://api-reference.kentico.com/api/CMS.EmailMarketing.EmailMarketingRecipientInfo.html

https://api-reference.kentico.com/api/CMS.EmailMarketing.RecipientListSettingsInfo.html

I'm hoping to find code that would let me:

  • Find a recipient list by ID
  • Find a recipient by their email address
  • Find what recipient lists a given recipient is in
  • Find what recipients are in a given recipient list
  • Add or remove recipients from recipient lists, ideally in bulk
  • Find the recipient that maps to a given contact, or vice-versa
Tags:
Email marketing C#

Answers

2025/08/25 11:34 PM
Accepted answer

Hi @cbass,

There is no direct API providers but you can use this instead https://docs.kentico.com/documentation/developers-and-admins/api/database-table-api

EmailMarketingRecipientInfo is the dedicated info class for managing email marketing recipients in Xperience by Kentico. This table stores the direct relationship between emails and their recipients.
IInfoProvider<EmailMarketingRecipientInfo> - Manages email marketing recipient data


Create a dedicated service class that encapsulates all recipient list operations, inject the required providers, and implement methods for each specific operation you need. This provides a clean API layer for your application to interact with recipient list functionality while leveraging Xperience by Kentico's contact group system.

Also if you are managing recipient lists as Contact Groups,then there is a dedicated info class (ContactGroupInfo)

Three Primary Providers:

  • IInfoProvider<ContactInfo> - Manages contact data
  • IInfoProvider<ContactGroupInfo> - Manages recipient lists (contact groups)
  • IInfoProvider<ContactGroupMemberInfo> - Manages membership relationships

Contact Management:

  • Find contacts by email address using ContactInfo provider
  • Create new contacts when needed
  • Retrieve contact details and properties

Recipient List Operations:

  • Find recipient lists by ID using ContactGroupInfo
  • Create new recipient lists as contact groups
  • Manage list metadata and settings

Membership Management:

  • Add/remove individual contacts to/from lists
  • Perform bulk operations for multiple contacts simultaneously
  • Query which lists a contact belongs to
  • Query which contacts are in a specific list

Thanks

2025/08/26 9:16 PM

Nikhila's answer covers most of the information, but I wanted to elaborate on the answer for the sake of anyone else seeking this information:

  • The feature in Kentico called 'Recipient Lists' are internally managed as ContactGroupInfo with the [ContactGroupIsRecipientList] flag set. You use the IInfoProvider for ContactGroupInfo class to manage them but also to manage dynamic Contact Groups (which do not have that flag set).

  • A ContactGroupMemberInfo (a recipient in a Recipient List) represents a single 'person' in a single Recipient List - this could be tied to ContactInfo or to AccountInfo (a group of ContactInfo with a single target email)

    • Aside from those two types, you could also just use the email in the Recipient List itself to map together a single 'person' across multiple Contact groups / Recipient Lists

As far as the other two classes I'd brought up:

  • It is technically true that EmailMarketingRecipientInfo is related to 'managing recipient data' - however it should be clarified that this does not mean 'recipients' in the sense of the 'Recipient Lists' Kentico feature. Instead, these are tied to individual emails (through the EmailConfigurationID field) - and appear to actually be the metadata for attempts to send a single email to a single 'email recipient' (which I believe could be in a Recipient List or a contact in a dynamic Contact Group). The fields on this are things such as a retry-count and whether the email succeeded.
  • RecipientListSettingsInfo, on the other hand, are specifically records to handle the metadata of a Recipient List that don't apply to Contact Groups as a whole - subscription confirmation and unsubscription pages.

To response this discussion, you have to login first.