Loading ...

REST API: Update Comment | Communifire Documentation

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

REST API: Update Comment

0 
 /5
0 (0votes)

Update comment

PUT /api/comments/{commentid}

Updates an existing comment using Comment ID with the properties as specified by JSON in the request body. Returns JSON indicating whether or not the specified comment was actually updated. 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 (see below) Unique identifier for a particular comment.
Comment JSON Used in the request body This is JSON that represents a comment object that you're updating.
Optional Parameters How to use Description
CommentText Used in the request body Comment text to be updated.
CommentStatus Used in the request body Status of comment to be updated.

Example URL to PUT: http://your-community.com/api/comments/600

Request JSON sample for updating the comment - Stringify your JSON data


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

Response JSON sample where indicator (true/false) is returned as ResponseData


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


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

Wiki Index

Pages

Intranet Software