Loading ...

REST API: Send Custom Notification | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Notifications » REST API: Send Custom Notification
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 7

REST API: Send Custom Notification

0 
 /5
0 (0votes)

Send Custom Notification

POST /api/notifications

Send a custom notification to specific people. Valid for Communifire version 6.0 and above.

Method Details

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 of the people to whom you want to send the notification.
ActionText Used in the request body Notification text that user is going to see.
Url Used in the request body URL that will open when the notification is clicked.
IsCustom Used in the request body Set to true.

Example Request

POST https://myintranet.communifire.com/api/notifications

Body:

{
   "IsCustom": true,
   "Url": "https://myintranet.communifire.com/myaccount",
   "ActionText": "Hey guys, please take a look at the My Account page.",
   "ToUserIDCsv": "5,10,23,45,56,67,78"
}

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