Loading ...

REST API: Set Content Read Status | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Set Content Read Status
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 4

REST API: Set Content Read Status

0 
 /5
0 (0votes)

Set Content Read Status

PUT /api/content/{ContentID}/version/{VersionID}/readstatus

Sets the read status on content marked as required reading. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
6.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.
ContentID Used in the request URL as a path parameter Unique identifier for a particular content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas.
VersionID Used in the request URL as a path parameter Version ID of the content to mark as read.
EntityType &EntityType=x - Used in the request URL as a query parameter

REST API: System Entity Types 
IsRead Used in the request body

Send true or false.

Example Request

PUT https://myintranet.communifire.com/api/content/219/version/1/readstatus?EntityType=3

Body:

true

Example Response

True/false is returned as ResponseData.

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

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

Wiki Index

Pages

Intranet Software