Create root category
POST {{baseUrl}}/api/v1/kbRootCategories
This API creates a root category in your knowledge base.
OAuth Scope
Desk.articles.CREATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| name (required) | <String> | Name of the category |
| description (required) | <String> | A brief description of the category |
| status | <String> default : HIDEINHELPCENTER | Activation status of the category |
| visibility | <String> default : NONE | Visibility setting of the category. Values allowed are: AGENTS, GROUPUSERS, ALLUSERS, NONE, and PRIVATE_IP. |
| groupIds | <list> | List of group IDs |
| articleViewType (required) | <String> | View to apply while listing help articles. Values allowed are: LISTVIEW and OVERVIEW. |
| isReviewEnabled (required) | <boolean> | Key that specifies whether the category must be reviewed or not |
| logoId (required) | <long> | ID of the logo to set for the category |
| associatedDepartmentIds (required) | <list> | IDs of the departments associated with the category |
| helpcenterId | <long> | ID of the help center to which the category belongs |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"modifiedTime":"2020-01-02T15:26:51.000Z","visibility":"ALL_USERS","articleViewType":"LISTVIEW","groups":[],"logoUrl":"https://desk.zoho.com/support/App/build/fonts/certificate.svg","feedbackTicketConversionPreference":{"departmentId":"5000000063895","assignee":{"photoURL":"https://desk.zoho.com/api/v1/agents/5000000000059/photo?orgId=15114553","name":"Charlie Marlie","id":"5000000000059","status":"ACTIVE","zuid":"15224545"},"status":"ENABLED"},"associatedDepartmentIds":["5000000063895"],"encryptedWorkspaceId":"uhahs234dha2342342424da2342342342","helpcenterId":"5000000015871","isReviewEnabled":true,"isTrashed":false,"createdBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"translations":[{"modifiedTime":"2020-01-02T15:24:42.000Z","createdBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"name":"Zoho Desk","description":"A helpdesk software","createdTime":"2020-01-02T15:24:42.000Z","modifiedBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"id":"5000000336004","permalink":"zoho-desk","locale":"en","categoryId":"5000000319037"}],"name":"Zoho Desk","createdTime":"2019-12-30T12:10:30.000Z","modifiedBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"id":"5000000319037","status":"SHOW_IN_HELPCENTER","order":"3","workspaceId":"asa432da353sda"}