Update category
- 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
Update category
- Updated on 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
PUT /categories/{id}
Updates a category with the ID in the respective language
Header
| Parameter | Type | Description |
|---|---|---|
| api_token | string | You can get the REST API from Settings > Advanced > API tokens. |
Route Parameter
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | Yes | string | The ID of the category |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | Category name |
| parent_category_id | string | The ID of the category where the 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 the parent) |
| icon | string | Unicode icon has to be the icon itself. Example, 📜 (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 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
| Parameter | Type | Description |
|---|---|---|
| id | string | The 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?