MailingLists In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:54 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:31:54

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IMailingLists>() and is defined in Telligent.Evolution.Platform.dll

Methods

MailingList Create(string emailAddress, Guid applicationId, Guid applicationTypeId, MailingListCreateOptions options = null);

Parameters

Name	Type	Description	Required
emailAddress	`string`	Email Address	Required
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required
options	`[[MailingListCreateOptions In-Process API Supplementary Type\|MailingListCreateOptions]]`	Options	Optional

Return Type

MailingList

AdditionalInfo Delete(Guid id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

MailingList Get(Guid id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required

Return Type

MailingList

MailingList GetByEmail(string emailAddress);

Parameters

Name	Type	Description	Required	Default	Options
emailAddress	`string`	Email Address	Required

Return Type

MailingList

PagedList<MailingList> List(MailingListListOptions options);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[MailingListListOptions In-Process API Supplementary Type\|MailingListListOptions]]`	Options	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<MailingList>

MailingList Update(Guid id, MailingListUpdateOptions options);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required
options	`[[MailingListUpdateOptions In-Process API Supplementary Type\|MailingListUpdateOptions]]`	Options	Required

Return Type

MailingList