Update category
  • 02 Feb 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Update category

  • Dark
    Light

PUT /categories/{id} 

Updates a category with the ID in the respective language


Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.


Route Parameter

ParameterRequiredTypeDescription
idYesstringThe ID of the category


Body Parameters

ParameterTypeDescription
namestringCategory name
parent_category_idstringThe ID of the category where the category will be moved (If left null category will be created at the top level)
ordernumberThe position of the category in the category tree (If left null it will be added to the end of the parent)
iconstringUnicode icon has to be the icon itself. Example, 📜 (Windows 10 - Winkey + . or Mac ⌃-⌘-Space Bar to open emoji menu)
hiddenbooleanHide / Show category
languagestringLanguage code for multilingual. If language is not given, the category would be updated in the 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

ParameterTypeDescription
idstringThe ID of the category
namestringName of the category
ordernumberThe position of the category in the category tree
iconstringUnicode representation of the icon or image URL

Was this article helpful?

What's Next