REST API: Send Notification

Anonymous User

Published: 6/7/2019

Grace Kamau

Updated: 9/23/2020

0 (0votes)

Send Notification

Send a notification to users. Valid for Communifire version 6.0 and above.

HTTP Method

POST

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.
ToUserIDCSV	Used in the request body	Comma-separated list of user IDs to whom you want to send the notification.
ActivityAction	Used in the request body	Unique ID for an activity. Refer to REST API: Activity Action ID .
EntityID	Used in the request body	Unique ID of a content.
EntityType	Used in the request body	Entity Type of the entity. Refer to REST API: System Entity Types .

Body:

{
   "ToUserIDCSV": "376",
   "ActivityAction": "1",
   "EntityID": "8912",
   "EntityType": 3
}

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.