MoxiWorks Platform
.NET SDK For MoxiWorks Public API
MoxiWorks.Platform.EmailCampiagnService Class Reference

Moxi Works Platform EmailCampign entities represent email campaigns established between agents and contacts via Moxi Works. More...

Public Member Functions

 EmailCampiagnService (IMoxiWorksClient client)
 
async Task< Response< EmailCampaignResults > > GetEmailCampaignsAsync (string agentId, AgentIdType agentIdType, string partnerContactId)
 Searches Moxi Works platform API for EmailCampaign entities. More...
 

Properties

IMoxiWorksClient Client [get, set]
 

Detailed Description

Moxi Works Platform EmailCampign entities represent email campaigns established between agents and contacts via Moxi Works.

Member Function Documentation

◆ GetEmailCampaignsAsync()

async Task<Response<EmailCampaignResults> > MoxiWorks.Platform.EmailCampiagnService.GetEmailCampaignsAsync ( string  agentId,
AgentIdType  agentIdType,
string  partnerContactId 
)

Searches Moxi Works platform API for EmailCampaign entities.

Parameters
agentIdMust include either: AgentUuid This is the Moxi Works Platform ID of the agent which an EmailCampaignentry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your EmailCampaignentry request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an EmailCampaign entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your EmailCampaign request to be accepted. Agent ID for your EmailCampaign request to be accepted.

Parameters
agentIdTypeWhat agentId type you are using.
partnerContactIdThis is the unique identifer you use in your system that has been associated with the w that you are creating an EmailCampaign entry about. You should have already created the Contact record on the Moxi Works Platform using Contact Create before attempting to use your system’s contact ID to show EmailCampaign entries for the Contact. Your request will be rejected if the Contact record does not exist.
Returns

The documentation for this class was generated from the following file: