Loading ...

REST API: Set Comment Status | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Comments » REST API: Set Comment Status
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 12

REST API: Set Comment Status

0 
 /5
0 (0votes)

Set comment status

PUT /api/comments/{commentid}/status

Sets the comment status (Published, Draft, etc). List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Events. Returns JSON indicating whether or not the specified comment status 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.
StatusID Used in the request body Status of the comment. Here are the accepted values:
  • PendingWorkflow = 0
  • Published = 1
  • Spam = 2 
  • Declined = 3

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

Request JSON sample for updating comment status


  "1"

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


{
    "IsError":false,
    "ResponseMessage":"596",
    "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