Update a section

PATCH {{baseUrl}}/api/v1/kbSections/:sectionId

This API updates a section in your helpdesk

OAuth Scope

  • Desk.articles.UPDATE

Attributes

Attribute NameData TypeDescription
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

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;modifiedTime&quot;:&quot;2020-01-07T01:15:14.000Z&quot;,&quot;visibility&quot;:&quot;ALL_USERS&quot;,&quot;description&quot;:&quot;Section 1 description&quot;,&quot;groups&quot;:[],&quot;logoUrl&quot;:&quot;https://desk.zoho.com/support/App/build/fonts/certificate.svg&quot;,&quot;rootCategoryId&quot;:&quot;5000000066427&quot;,&quot;isTrashed&quot;:false,&quot;createdBy&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Zylker&quot;,&quot;id&quot;:&quot;5000000015867&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;343224&quot;},&quot;translations&quot;:[{&quot;modifiedTime&quot;:&quot;2020-01-07T01:15:14.000Z&quot;,&quot;createdBy&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Zylker&quot;,&quot;id&quot;:&quot;5000000015867&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;343224&quot;},&quot;name&quot;:&quot;For Agents&quot;,&quot;description&quot;:&quot;Section 1 description&quot;,&quot;createdTime&quot;:&quot;2020-01-07T01:15:14.000Z&quot;,&quot;modifiedBy&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Zylker&quot;,&quot;id&quot;:&quot;5000000015867&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;343224&quot;},&quot;id&quot;:&quot;5000000341019&quot;,&quot;permalink&quot;:&quot;for-agents&quot;,&quot;locale&quot;:&quot;en&quot;,&quot;categoryId&quot;:&quot;5000000341017&quot;}],&quot;name&quot;:&quot;For Agents&quot;,&quot;createdTime&quot;:&quot;2020-01-07T01:15:14.000Z&quot;,&quot;parentCategoryId&quot;:&quot;5000000340014&quot;,&quot;modifiedBy&quot;:{&quot;photoURL&quot;:null,&quot;name&quot;:&quot;Zylker&quot;,&quot;id&quot;:&quot;5000000015867&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;zuid&quot;:&quot;343224&quot;},&quot;id&quot;:&quot;5000000341017&quot;,&quot;status&quot;:&quot;SHOW_IN_HELPCENTER&quot;,&quot;order&quot;:&quot;2&quot;}