API ReferenceGuides
Guides
Home

Update Event

Use this operation to update any of the writable fields of an existing Event object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.

Suggest Edits

Parameters

Body Params
JSON:json
Event details needs to be passed as body parameter,it should be in JSON format.Unique parameter need to be passed in JSON for eg. Event Id/Event Subject.
XML:string
Event details needs to be passed as body parameter,it should be in XML format.Unique parameter need to be passed in XML for eg. Event Id/Event Subject.
Path Params
yourCompany:string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Event will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Event
Header Params
Accept:string
Response header need to be passed for eg. application/json or application/xml.
Query Auth
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.
Header Auth
apiKey:string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code 

{
	"Events": {
		"Event":[{
			"EventId": "3422",
			"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>
      	<EventId>3422</EventId>
        <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="PUT">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="EventId" type="xsd:string" style="body" 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 over 1 year ago

© Copyright 2022 Agiliron - All Rights Reserved.