Loading ...

REST API: Update Task Comment | Communifire Documentation

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

REST API: Update Task Comment

0 
 /5
0 (0votes)

Update Task Comment

PUT /api/tasks/comments/{CommentID}

Update a comment on a task. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
PUT
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.
CommentID Used in the request URL as a path parameter The unique ID of the task comment
CommentText Used in the request body The comment to add

Example Request

PUT https://myintranet.communifire.com/api/tasks/comments/304

Body:

"No worries! Let's come back to this next week."

Example Response

Task comment JSON is returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "Comment updated successfully.",
   "ResponseData": {
      "CommentID": 304,
      "IsInternal": false,
      "IssueID": 489,
      "ProjectID": 0,
      "SpaceID": 252,
      "Status": 1,
      "UserID": 641,
      "UserName": "admin",
      "CommentTextadminNo worries! Let's come back to this next week.",
      "CommentTextUnprocessed": "My comment",
      "CommentTags": "",
      "IssueTitle": "Discuss role, goals, and projects with supervisor",
      "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.99",
      "CommentDateFullText": "Tuesday, November 3, 2020 at 02:52",
      "CommentDateString": "4 minutes ago",
      "IssueStatusID": 0,
      "OldIssueStatusID": 0,
      "CommentTextHtmlFormatted": "No worries! Let's come back to this next week.",
      "CommentTextFormatted": "No worries! Let's come back to this next week.",
      "IssueCommentURL": "/spaces/252/human-resources/cases/case/489#304",
      "UserDisplayName": "Alexis Fox",
      "CanBeDeleted": false,
      "CanBeEdited": false,
      "IssueRecipientsCSV": "376,525,579",
      "IssueReportedByUserID": 376,
      "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