Events API

Event CRUD API - Add event API

OVERVIEW



This is the latest version of this API endpoint valid from Collaborate 5.0 and above

API method to add a new event to the Collaborate Calendar module. 

Request URL

POST /{apiversion}/event/addevent?siteid={siteid}

Request parameters

Parameter Value Description
siteid Integer The ID of the site

Request body

An event object should be sent in the request body.

Response 

The response will be a 200 OK HTTP response with the ID of the event. If the response is not successful an error object will be returned with the information of the failure. 

 

Response body

<event>

    <externalID></externalID>

    <messageCode>13</messageCode>

    <message>Event created successfully</message>

    <processtype>normal</processtype>

    <eventID>12</eventID>

</event>

 

Comments


2 Comments

Last Updated: Jun 09,2023