Loading ...

REST API: Update Content | Communifire Documentation

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

REST API: Update Content

0 
 /5
0 (0votes)

Update Content

PUT /api/content/{ContentID}

Update existing content. List of supported entities: Articles, Blogs, CMS Pages, Albums, Wikis, Ideas, Forums, Forum Groups, Forum Topics, Forum Posts. 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
Note: Refer to  REST API: Create Content  to check required, not required, and optional parameters for every entity.
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 content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, Forum Posts.
Content JSON Used in the request body This is JSON that represents a content object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
ContentTitle Used in the request body Content Title of the entity to be updated.
ContentSummary Used in the request body Content Summary of Articles, Blogs or Videos to be updated.
ContentBody Used in the request body Content Body of the entity to be updated.
CategoryID Used in the request body CategoryID for Articles, Blogs, CMSPage or Ideas to be updated.
ParentContentID Used in the request body Used in Wikis, Forums, Forum Topics, Forum Posts to specify the parent content under which this content is updated.
ContentStageID Used in the request body Used in Ideas to specify Idea stage.
IsFeatured Used in the request body Used to mark content as "featured".

true= Set the content as featured
RequiresReReadConfirmation Used in the request body

Used in Wiki, Articles, Blogs and other content types that support required reading, with the exception of Files. 

true = will require people who have already confirmed required reading to re-confirm the new version once published. 

false = updated content version will be required reading only for those who have not yet confirmed the prior version.

Example Request

PUT https://myintranet.communifire.com/api/content/2304

Body:

"{
   \"ContentTitle\":\"Jupiter is the fifth planet from the Sun\",
   \"ContentBody\":\"Jupiter is primarily composed of hydrogen with a quarter of its mass being helium, although helium only comprises about a tenth of the number of molecules. It may also have a rocky core of heavier elements, but like the other giant planets, Jupiter lacks a well-defined solid surface. \"
}"

Note: Stringify your JSON data.

Example Response

Content ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"ToBePublished",
    "ResponseData":2304
}

 

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

Wiki Index

Pages

Intranet Software