Update a section
PATCH {{baseUrl}}/api/v1/kbSections/:sectionId
This API updates a section in your helpdesk
OAuth Scope
Desk.articles.UPDATE
Attributes
Attribute Name | Data Type | Description |
---|---|---|
name | <String> | Section Name |
description | <String> | A short description of the section |
logoId | <long> | Logo for each category |
status | <String> default : HIDEINHELPCENTER | Status of the section |
visibility | <String> default : NONE | Visibility of the section. Values allowed are AGENTS , GROUP_USERS , ALL_USERS , PRIVATE_IP , NONE |
groupIds | <list> | group ids list |
articlePermission | <String> | To update the article permission based on category visibility |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"modifiedTime":"2020-01-07T01:15:14.000Z","visibility":"ALL_USERS","description":"Section 1 description","groups":[],"logoUrl":"https://desk.zoho.com/support/App/build/fonts/certificate.svg","rootCategoryId":"5000000066427","isTrashed":false,"createdBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"translations":[{"modifiedTime":"2020-01-07T01:15:14.000Z","createdBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"name":"For Agents","description":"Section 1 description","createdTime":"2020-01-07T01:15:14.000Z","modifiedBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"id":"5000000341019","permalink":"for-agents","locale":"en","categoryId":"5000000341017"}],"name":"For Agents","createdTime":"2020-01-07T01:15:14.000Z","parentCategoryId":"5000000340014","modifiedBy":{"photoURL":null,"name":"Zylker","id":"5000000015867","status":"ACTIVE","zuid":"343224"},"id":"5000000341017","status":"SHOW_IN_HELPCENTER","order":"2"}