Loading ...

REST API: Recognize User | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Recognition » REST API: Recognize User
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Recognize User

0 
 /5
0 (0votes)

Recognize User

POST /api/recognition

Award a badge to a user. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
8.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.
ToUserID Used in the request URL as a query parameter The user ID of the user to recognize.
AwardContentID Used in the request URL as a query parameter The award ID.
Reason Used in the request URL as a query parameter A message to attach to the award.

Example Request

POST https://myintranet.communifire.com/api/recognition?ToUserID=5&AwardContentID=6&Reason=Thanks for your quick response to tickets!

Example Response

The award ID and wall post ID are returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "Badge awarded successfully.",
   "ResponseData": {
      "WallID": 8,
      "AwardID": 4
   }
}

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

Wiki Index

Pages

Intranet Software