REST API: Create Case Project Categories

Christopher Hercules

Published: 2/17/2023

0 (0votes)

Create Case Project Categories

Create a list of categories for a particular case project. Valid for Communifire version 6.0 and above.

HTTP Method

POST

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.
ProjectID	Used in the request URL as a path parameter	Unique identifier for a particular case project.
CategoryName	Used in the request body	Name of category.

Optional Parameters	How to use	Description
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.

Body:

{
    "CategoryName": "Finance"
}

Case category JSON object is returned as ResponseData.

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

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