Add Event
Use this operation to add new Event object.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Events": {
"Event": [{
"Subject": "Test New Event",
"StartDate": "01-24-2020",
"StartTime": "05:36:00",
"DurationInHours": "1",
"DurationInMinutes": "00",
"RecurringEvents": "",
"RepeatUntil": "01-25-2020",
"AccountName": "Account1",
"ContactName": "Contact1",
"RelatedToType": "Accounts",
"RelatedToValue": "Account1",
"SendReminder": "Yes",
"ReminderDays": "0",
"ReminderHours": "0",
"ReminderMinute": "0",
"Status": "Planned",
"SendNotification": "No",
"ActivityType": "Call",
"Location": "US",
"CreatedTime": "01-24-2020 05:37:21",
"ModifiedTime": "01-24-2020 05:37:21",
"Description": "The Description Goes here.",
"EventCustomFields": {
"CustomField": [
{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
}
}]
}
}
<Events>
<Event>
<Subject>Test New Event</Subject>
<StartDate>01-24-2020</StartDate>
<StartTime>05:36:00</StartTime>
<DurationInHours>1</DurationInHours>
<DurationInMinutes>00</DurationInMinutes>
<RecurringEvents></RecurringEvents>
<RepeatUntil>01-25-2020</RepeatUntil>
<AccountName>Account1</AccountName>
<ContactName>Contact1</ContactName>
<RelatedToType>Accounts</RelatedToType>
<RelatedToValue>Account1</RelatedToValue>
<SendReminder>Yes</SendReminder>
<ReminderDays>0</ReminderDays>
<ReminderHours>0</ReminderHours>
<ReminderMinute>0</ReminderMinute>
<Status>Planned</Status>
<SendNotification>No</SendNotification>
<ActivityType>Call</ActivityType>
<Location>US</Location>
<CreatedTime>01-24-2020 05:37:21</CreatedTime>
<ModifiedTime>01-24-2020 05:37:21</ModifiedTime>
<Description>The Description Goes here.</Description>
<EventCustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</EventCustomFields>
</Event>
</Events>
Sample Response
{
"MCM": {
"response": {
"objectType": "Event",
"syncTime": "2021-06-10 03:23:14"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"event_subject": "Test New Event",
"event_id": "203060"
}
}
}
}
}
}
<MCM>
<response>
<objectType>Event</objectType>
<syncTime>2021-06-10 03:23:14</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<event_subject>Test New Event</event_subject>
<event_id>203060</event_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Event">
<method name="POST">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="Subject" type="xsd:string" style="body" required="true"/>
<param name="StartDate" type="xsd:date" style="body" required="true"/>
<param name="StartTime" type="xsd:time" style="body" required="true"/>
<param name="DurationInHours" type="xsd:string" style="body"/>
<param name="DurationInMinutes" type="xsd:string" style="body"/>
<param name="RecurringEvents" type="xsd:string" style="body"/>
<param name="RepeatUntil" type="xsd:date" style="body"/>
<param name="AccountName" type="xsd:string" style="body"/>
<param name="ContactName" type="xsd:string" style="body"/>
<param name="RelatedToType" type="xsd:string" style="body"/>
<param name="RelatedToValue" type="xsd:string" style="body"/>
<param name="SendReminder" type="xsd:string" style="body"/>
<param name="ReminderDays" type="xsd:string" style="body"/>
<param name="ReminderHours" type="xsd:string" style="body"/>
<param name="ReminderMinute" type="xsd:string" style="body"/>
<param name="Status" type="xsd:string" style="body"/>
<param name="SendNotification" type="xsd:string" style="body"/>
<param name="ActivityType" type="xsd:string" style="body"/>
<param name="Location" type="xsd:string" style="body"/>
<param name="CreatedTime" type="xsd:dateTime" style="body"/>
<param name="ModifiedTime" type="xsd:dateTime" style="body"/>
<param name="Description" type="xsd:string" style="body"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 12 hours ago