Loading ...

REST API: Delete Event | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Delete Event
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 11

REST API: Delete Event

0 
 /5
0 (0votes)

Delete Event

DELETE /api/events/{EventID}

Delete an event. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
DELETE
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
EventID Used in the request URL as a path parameter Unique identifier for a particular event.
Optional Parameters How to use Description
SendNotifications &SendNotifications=x - Used in the request URL as a query parameter Whether to send invited users and attendees a cancellation notification. Set as true or false. Default is true.

Example Request

DELETE https://myintranet.communifire.com/api/events/23

Example Response

True/false is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":true
}


Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software