Loading ...

REST API: Update Content Category | Communifire Documentation

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

REST API: Update Content Category

0 
 /5
0 (0votes)

Update Content Category

PUT /api/content/categories/{CategoryID}

Update a content category. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas. 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.
CategoryID Used in the request URL as a path parameter Unique identifier for a particular content category. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas.
Category JSON Used in the request body This is JSON that represents a content category object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
ParentCategoryID Used in the request body ID of the parent category of the new category.
StatusID Used in the request body Unique ID to identify the status of category. A category can have “Draft” or “Active” status. Draft Category is not visible to the Users. Accepted values are:
  • 1 = Published
  • 2 = Draft
CategoryName Used in the request body Name of category.
CategoryDescription Used in the request body Brief description of category.

Example Request

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

"{
    \"CategoryName\":\"Satellite\",
    \"CategoryDescription\":\"A celestial body orbiting the earth or another planet.\"
}"

Note: Stringify your JSON data.

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