Loading ...

REST API: Delete User From Event | Communifire Documentation

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

REST API: Delete User From Event

0 
 /5
0 (0votes)

Delete User From Event

DELETE /api/events/{EventID}/users/members/{UserID}

Remove a user from an event. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
DELETE
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 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 ID of the event.
UserID Used in the request URL as a path parameter Unique ID of the user to remove from the event.
Optional Parameters How to use Description
Notify &Notify=x - Used in the request URL as a query parameter Whether to send the user a cancellation notification. True by default.

Example Request

DELETE https://myintranet.communifire.com/api/events/130/users/members/1018?Notify=true

200 OK response code is returned if successful


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

Wiki Index

Pages

Intranet Software