Add forum
POST {{baseUrl}}/api/v1/communityCategory
This API adds a forum in a community category.
OAuth Scope
Desk.community.UPDATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| name | <String> | Name of the forum |
| parentCategoryId | <long> | ID of the community category under which the forum must be added |
| 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 and MODERATORS. |
| post | <JSONObject> | Post permission setting of the community category or forum. |
| respond | <JSONObject> | Respond permission setting of 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":"GROUPS","departmentId":"20628000000020011","groups":["700000001671"],"description":"forum 1","canAutoConvertTicket":"true","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":"forum","deparmentIdForTicketCreation":"20628000000020011","parentCategoryId":"4000000003037","id":"4000000012009","position":"1","permalink":"forum-1","respond":{"groupIds":["20628000000020011"],"permission":"GROUPS"},"child":[],"moderators":[],"status":"ENABLED"}