Add a category

Updated On 06 Mar 2019
1 Minute To Read
Contributors

Print
Share
Dark

Light

POST/categories

Adds a new category

Header

Parameter	Type	Description
api_token	string	REST API key you can get it from Settings > API.

Body Parameters

Parameters highlighted in bold are mandatory

Parameter	Type	Description
name	string	Category name
project_version_id	string	The project version in which the category will be created
parent_category_id	string	The id of the category where category will be created ( If left null category will be created at the top level )
order	number	The position of the category in the category tree ( If left null it will be added to the end of parent )
icon	string	Unicode icon, has to be the icon itself e.g. 📜 ( Windows 10 - Winkey + . or Mac ⌃-⌘-Space Bar to open emoji menu )

Sample Request

{
  "name":"My Category",
  "project_version_id":"7ba483c0-0929-4bb6-aa43-04a2f4bb8453"
}

Sample Response

{
    "data": {
        "id": "b8fa8c09-aecc-4e40-a54d-a77d21bf8668",
        "name": "My Category",
        "order": 1,
        "icon": "📜"
    },
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}

Response Data

Parameter	Type	Description
id	string	ID of the category
name	string	Name of the category
order	number	The position of the category in the category tree
icon	string	Unicode representation of the icon

Was This Article Helpful?

Table Of Contents