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

Moxi Works Platform Event entity represents appointments, meetings or other events scheduled for an agent. More...

Properties

string PartnerEventId [get, set]
 This is the unique identifer you use in your system that has been associated with the Event that you are creating. This data is required and must be a unique key. More...
 
string AgentUuId [get, set]
 This is the Moxi Works Platform ID of the Agent which an Event entry 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 Event Create request to be accepted. More...
 
string MoxiWorksAgentId [get, set]
 This is the Moxi Works Platform ID of the Agent which this Event is to be associated with. This will be a string that may take the form of an email address, or a unique identification string. This data is required and must reference a valid Moxi Works Agent ID for your Event Create request to be accepted. More...
 
string EventSubject [get, set]
 This is a short, descriptive, human readable phrase to be displayed to the agent which lets them know what this Event regards. More...
 
string EventLocation [get, set]
 This is a human readable locatition reference regarding where the event is located that will be meaningful to the agent. More...
 
string Note [get, set]
 Notes about the event. More...
 
bool SendReminder [get, set]
 Whether to send a reminder about the event to attendees before the event starts. More...
 
int RemindMinutesBefore [get, set]
 If send_reminder is true, this is how many minutes before the start of the event to send the reminder. Default is 15 minutes before. More...
 
int EventStart [get, set]
 This is the Unix timestamp representing the start time of the Event that you are creating. This data is required and must be a valid Unix timestamp. More...
 
int EventEnd [get, set]
 This is the Unix timestamp representing the end time of the Event that you are creating. This data is required and must be a valid Unix timestamp. More...
 
bool AllDay [get, set]
 Whether the event is an all day event. More...
 
List< string > Attendees = new List<string>() [get, set]
 This is a list of contacts that have already been added through the Moxi Works Platform API who will be present at the referenced event. (Use IDs from your system – i.e. partner_contact_id from Contact Create ). More...
 

Detailed Description

Moxi Works Platform Event entity represents appointments, meetings or other events scheduled for an agent.

Property Documentation

◆ AgentUuId

string MoxiWorks.Platform.Event.AgentUuId
getset

This is the Moxi Works Platform ID of the Agent which an Event entry 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 Event Create request to be accepted.

◆ AllDay

bool MoxiWorks.Platform.Event.AllDay
getset

Whether the event is an all day event.

◆ Attendees

List<string> MoxiWorks.Platform.Event.Attendees = new List<string>()
getset

This is a list of contacts that have already been added through the Moxi Works Platform API who will be present at the referenced event. (Use IDs from your system – i.e. partner_contact_id from Contact Create ).

◆ EventEnd

int MoxiWorks.Platform.Event.EventEnd
getset

This is the Unix timestamp representing the end time of the Event that you are creating. This data is required and must be a valid Unix timestamp.

◆ EventLocation

string MoxiWorks.Platform.Event.EventLocation
getset

This is a human readable locatition reference regarding where the event is located that will be meaningful to the agent.

◆ EventStart

int MoxiWorks.Platform.Event.EventStart
getset

This is the Unix timestamp representing the start time of the Event that you are creating. This data is required and must be a valid Unix timestamp.

◆ EventSubject

string MoxiWorks.Platform.Event.EventSubject
getset

This is a short, descriptive, human readable phrase to be displayed to the agent which lets them know what this Event regards.

◆ MoxiWorksAgentId

string MoxiWorks.Platform.Event.MoxiWorksAgentId
getset

This is the Moxi Works Platform ID of the Agent which this Event is to be associated with. This will be a string that may take the form of an email address, or a unique identification string. This data is required and must reference a valid Moxi Works Agent ID for your Event Create request to be accepted.

◆ Note

string MoxiWorks.Platform.Event.Note
getset

Notes about the event.

◆ PartnerEventId

string MoxiWorks.Platform.Event.PartnerEventId
getset

This is the unique identifer you use in your system that has been associated with the Event that you are creating. This data is required and must be a unique key.

◆ RemindMinutesBefore

int MoxiWorks.Platform.Event.RemindMinutesBefore
getset

If send_reminder is true, this is how many minutes before the start of the event to send the reminder. Default is 15 minutes before.

◆ SendReminder

bool MoxiWorks.Platform.Event.SendReminder
getset

Whether to send a reminder about the event to attendees before the event starts.


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