Recipient List API
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
Answers
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 dataIInfoProvider<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
To answer this question, you have to login first.