Loading ...

REST API: Update Case Comment | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Cases » REST API: Case Comments » REST API: Update Case Comment
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 17

REST API: Update Case Comment

0 
 /5
0 (0votes)

Update Case Comment

PUT /api/case/comments/{CommentID}

Updates an existing case comment. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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 Unique identifier for a particular case comment.
CaseComment JSON Used in the request body This is JSON that represents a case comment object that you're updating.
Optional Parameters How to use Description
CommentText Used in the request body Comment text to be updated.

Example Request

PUT https://myintranet.communifire.com/api/case/comments/600

Body:

"{
    \"CommentText\":\"These are some great tips.\"
}"

Note: Stringify your JSON data.

Example Response

Indicator (true/false) is returned as ResponseMessage.

{
    "IsError":false,
    "ResponseMessage":"true",
    "ResponseData":"600"
}

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

Wiki Index

Pages

Intranet Software