Loading ...

REST API: Add Task Comment | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Tasks » REST API: Add Task Comment
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Add Task Comment

0 
 /5
0 (0votes)

Add Task Comment

POST /api/tasks/{TaskID}/comments

Add a comment on a task. 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.
TaskID Used in the request URL as a path parameter Unique ID of the task to comment on
CommentText Used in the request body The comment to add

Example Request

POST https://myintranet.communifire.com/api/tasks/489/comments

Body:

"Looks good to me!"

Example Response

Task comment JSON is returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "Comment added successfully.",
   "ResponseData": {
      "CommentID": 304,
      "IsInternal": false,
      "IssueID": 489,
      "ProjectID": 0,
      "SpaceID": 252,
      "Status": 1,
      "UserID": 641,
      "UserFirstName": "Alexis",
      "UserLastName": "Fox",
      "CommentText": "Looks good to me!",
      "AvatarPath": "https://myintranet.communifire.com/Assets/Uploaded-Photos/641/d523e5a3-10cc-4c4b-90c1-99812751e983.png",
      "UserProfilePath": "https://myintranet.communifire.com/people/grace",
      "CommentDate": "2020-11-03T22:52:15.9887115Z",
      "CommentDateString": "just now",
      "IssueStatusID": 0,
      "OldIssueStatusID": 0,
      "CommentTextHtmlFormatted": "Looks good to me!",
      "CommentTextFormatted": "Looks good to me!",
      "CanBeDeleted": true,
      "CanBeEdited": true,
      "IssueReportedByUserID": 0,
      "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