{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter KBRootCategory API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "KBRootCategory",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Remove review owner",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/reviewOwners/remove",
            "params": [
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API removes review owners of a root category in your helpdesk"
        },
        {
          "info": {
            "name": "Get root category",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId",
            "params": [
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches the details of a root category."
        },
        {
          "info": {
            "name": "List root categories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/kbRootCategories",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional information related to the category. Values allowed are: publicArticlesCount, allArticlesCount, publishedArticleCount, allArticleTemplateCount and sectionsCount."
              },
              {
                "name": "isReviewEnabled",
                "value": "",
                "type": "query",
                "description": "Key that specifies whether the category must be reviewed or not"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department associated with the category"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Key that sorts the categories, based on a specific attribute: name or order"
              }
            ]
          },
          "docs": "This API lists a particular number of root categories, based on the limit defined."
        },
        {
          "info": {
            "name": "Create root category",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/kbRootCategories",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a root category (i.e., parent category) in your knowledge base."
        },
        {
          "info": {
            "name": "Add moderators",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/moderators/add",
            "params": [
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API adds moderators to a root category in your helpdesk.<br/><br/>_Note_:<br/>Moderators act as designated agents within the primary department with access to the Moderation Panel. They are responsible for reviewing and managing comments awaiting approval or flagged as spam."
        },
        {
          "info": {
            "name": "Get review owners",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/reviewOwners",
            "params": [
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches review owners of a root category in your helpdesk"
        },
        {
          "info": {
            "name": "Add review owner",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/reviewOwners/add",
            "params": [
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API adds review owners of a root category in your helpdesk"
        },
        {
          "info": {
            "name": "Remove a permalink of a root category",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/translations/:locale/permalinks/remove",
            "params": [
              {
                "name": "locale",
                "value": "",
                "type": "path"
              },
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API removes a permalink of a root category translation"
        },
        {
          "info": {
            "name": "Add a permalink to a root catgeory",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/translations/:locale/permalinks/add",
            "params": [
              {
                "name": "locale",
                "value": "",
                "type": "path"
              },
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API adds a permalink to a root category translation"
        },
        {
          "info": {
            "name": "Get a category tree",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/categoryTree",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include params are publicArticlesCount, allArticlesCount, publishedArticleCount, publishedArticleTemplateCount and portalUrl"
              },
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches the full tree of a root category in your helpdesk"
        },
        {
          "info": {
            "name": "Remove moderators",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/kbRootCategories/:rootCategoryId/moderators/remove",
            "params": [
              {
                "name": "rootCategoryId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API removes moderators from a root category in your helpdesk.<br/><br/>_Note_:<br/>Moderators act as designated agents within the primary department with access to the Moderation Panel. They are responsible for reviewing and managing comments awaiting approval or flagged as spam."
        }
      ]
    }
  ],
  "bundled": true
}