Update category or forum
PATCH {{baseUrl}}/api/v1/communityCategory/([0-9]+)
This API updates the details of a category or forum.
OAuth Scope
Desk.community.UPDATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| name | <String> | Name of the community category or forum |
| description | <String> | A brief description of the community category or forum |
| visibility | <String> | Visibility setting of the community category or forum. Values allowed are: ALL, LOGGED_IN_USERS, GROUPS , AGENTS and MODERATORS. |
| post | <JSONObject> | Post permission setting of the community category or forum. |
| respond | <JSONObject> | Respond permission setting of the community category or forum. |
| moderators | <JSONArray> | Agents who moderate the community category or forum |
| groupIds | <JSONArray> | Group Ids to associate |
| moderation | <String> | Moderation setting for the community category or forum. Values allowed are: NONE (no moderation), ALL_POSTS (all posts of category will be moderated) and FIRST_POST (only the first forum post of users will be moderated). |
| canAutoConvertTicket | <boolean> | Key that defines whether topics posted in the forum must be automatically converted into tickets or not |
| associatedDepartmentIds | <JSONArray> | IDs of the deparments to be associated with category |
| deparmentIdForTicketCreation | <long> | ID of the deparment in which the ticket must be created |
| logoId | <long> | ID of the uploaded community category logo |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"isFollowing":"false","visibility":"GROUP","departmentId":"20628000000020011","description":"description","groups":[{"name":"group - 1","id":"700000001671"}],"canAutoConvertTicket":true,"childs":[],"associatedDepartmentIds":["20628000000020011"],"photoUrl":"https://desk.zoho.com/api/v1/communityCategory/4000000012009/logo/4000000012019?orgId=1234567","post":{"groupIds":["20628000000020011"],"permission":"GROUPS"},"permissions":["POST","RESPOND"],"moderation":"FIRST_POST","name":"new dep updated","deparmentIdForTicketCreation":"20628000000020011","parentCategoryId":"null","id":"20628000000020011","position":"1","permalink":"new-dep-updated-permalink","respond":{"groupIds":["20628000000020011"],"permission":"GROUPS"},"status":"ENABLED","moderators":[{"photoUrl":"https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456","name":"user 2","id":"7000000015971","type":"AGENT"}]}