Update a category

Updated On 02 Sep 2020
1 Minute To Read
Contributors

Print
Share
Dark

Light

PUT/categories/{id}

Updates a category with the ID in respective language

Header

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

Route Parameter

Parameters highlighted in bold are mandatory

Parameter	Type	Description
id	string	ID of the category

Body Parameters

Parameter	Type	Description
name	string	Category name
parent_category_id	string	The id of the category where category will be moved ( 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 )
hidden	boolean	Hide / Show category
language	string	Language code for multilingual. If language is not given, the category would be updated in default language

Sample Request

{
  "name":"New Category Name",
  "language": "en"
}

Sample Response

{
    "data": {
        "id": "b8fa8c09-aecc-4e40-a54d-a77d21bf8668",
        "name": "New Category Name",
        "order": 8,
        "icon": null
    },
    "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 or image url

Was This Article Helpful?

Table Of Contents