Loading ...

REST API: Create Reminder | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Event Reminders » REST API: Create Reminder
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Create Reminder

0 
 /5
0 (0votes)

Create Reminder

PUT /api/events/reminder

Add a reminder for a particular event. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
PUT
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.
EntityType Used in the request body Entity type of event is 5.
EntityID Used in the request body Unique ID of the event.
ReminderType Used in the request body The time unit of the reminder. Refer to REST API: Event Reminder Types .
ReminderTime Used in the request body The reminder time.
UserID Used in the request body The user to add a reminder for.
Note: Only a site administrator can add a reminder for other users.

Example Request

PUT https://myintranet.communifire.com/api/events/reminder

Body:

{
  "EntityType": 5,
  "EntityID": 153,
  "ReminderType": 1,
  "ReminderTime": 55,
  "UserID": 1017
}

Example Response

Reminder JSON is returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "",
   "ResponseData": {
      "ReminderID": 633,
      "EntityType": 5,
      "EntityID": 153,
      "ReminderType": 1,
      "ReminderTime": 55,
      "UserID": 1017,
      "ReminderSent": false,
      "TenantID": 1
   }
}

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

Wiki Index

Pages

Intranet Software