Loading ...

REST API: Create Content Category | Communifire Documentation

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

REST API: Create Content Category

0 
 /5
0 (0votes)

Create Content Category

POST /api/content/categories

Create 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
POST
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.
Category JSON Used in the request body This is JSON that represents a category object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
CategoryName Used in the request body Name of category.
CategoryDescription Used in the request body Brief description of category.
EntityType Used in the request body Which entity type to create the category for. Possible values:
  • Article
  • Blog
  • Video
  • CMSPage
  • Idea
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
Optional Parameters How to use Description
ParentCategoryID Used in the request body ID of the parent category to create the category under.
SpaceID Used in the request body Space ID if the category belongs to a space. If not provided, the category will be created for the top level community.

Example Request

POST https://myintranet.communifire.com/api/content/categories

Body:

{
    "CategoryDescription":"A celestial body moving in an elliptical orbit round a star.",
    "CategoryName": "Planets",
    "EntityType":"Blog",
    "SpaceID": 265,
    "StatusID": 1
}

Example Response

Category ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"True",
    "ResponseData":1696
}

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

 

Wiki Index

Pages

Intranet Software