Zoho Community Preferences API

The CommunityPreferences API from Zoho — 2 operation(s) for communitypreferences.

Operations 3

GET /api/v1/communityPreferences Get community preferences #
POST /api/v1/communityPreferences Set community preferences #
GET /api/v1/communityModeration/counts Get moderation stats #

Documentation

Specifications

Code Examples

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zoho-communitypreferences-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoho-communitypreferences-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Helpcenter Community Preferences API
  version: 1.0.0
tags:
- name: CommunityPreferences
paths:
  /api/v1/communityPreferences:
    get:
      tags:
      - CommunityPreferences
      summary: Get community preferences
      description: This API fetches the settings defined for the user community in your help desk portal.
      operationId: getCommunityPreferences
      parameters:
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/getCommunityPrefereneces'
        '500':
          $ref: ./Common.json#/components/responses/internalErrorResponse
        '403':
          $ref: ./Common.json#/components/responses/forbiddenErrorResponse
      security:
      - iam-oauth2-schema:
        - Desk.forums.READ
        - Desk.community.READ
      x-audience:
      - external-public
    post:
      tags:
      - CommunityPreferences
      summary: Set community preferences
      description: This API helps define the settings for the user community in your help desk portal.
      operationId: updateCommunityPreferences
      parameters:
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/getCommunityPrefereneces'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '500':
          $ref: ./Common.json#/components/responses/internalErrorResponse
        '204':
          $ref: ./Common.json#/components/responses/emptyResponse
        '403':
          $ref: ./Common.json#/components/responses/forbiddenErrorResponse
      security:
      - iam-oauth2-schema:
        - Desk.forums.UPDATE
        - Desk.community.UPDATE
      x-audience:
      - external-public
  /api/v1/communityModeration/counts:
    get:
      tags:
      - CommunityPreferences
      summary: Get moderation stats
      description: This API fetches statistics related to topic/comment moderation in the user community.
      operationId: getModerationCounts
      parameters:
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/communityModerationCountDetails'
        '500':
          $ref: ./Common.json#/components/responses/internalErrorResponse
        '403':
          $ref: ./Common.json#/components/responses/forbiddenErrorResponse
      security:
      - iam-oauth2-schema:
        - Desk.forums.READ
        - Desk.community.READ
      x-audience:
      - external-public
components:
  responses:
    communityModerationCountDetails:
      description: communityModerationCountDetails template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              awaitingApproval:
                $ref: ./CommunityPreferences.json#/components/schemas/countDetails
              moderated:
                $ref: ./CommunityPreferences.json#/components/schemas/moderatedCountDetails
              spam:
                $ref: ./CommunityPreferences.json#/components/schemas/countDetails
              trashed:
                $ref: ./CommunityPreferences.json#/components/schemas/countDetails
            required:
            - awaitingApproval
            - moderated
            - spam
            - trashed
          examples:
            Valid responses Definitions:
              value:
                awaitingApproval:
                  comments: '35'
                  topic: '25'
                moderated:
                  topic: '25'
                spam:
                  comments: '35'
                  topic: '25'
                trash:
                  comments: '35'
                  topic: '25'
    getCommunityPrefereneces:
      description: getCommunityPrefereneces template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              landingPage:
                type:
                - string
                - 'null'
                enum:
                - ALLCATEGORY
                - RECENTPOST
                maxLength: 100
                minLength: 0
            required:
            - landingPage
          examples:
            Valid responses Definitions:
              value:
                landingPage: ALL_CATEGORY
  requestBodies:
    getCommunityPrefereneces:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              landingPage:
                type:
                - string
                - 'null'
                description: 'Key that determines the content to display on the home page of the user community. Values allowed are: @ALLCATEGORIES@ (all community categories are displayed), and @RECENTPOSTS@ (only the latest topics in the community are displayed).'
                enum:
                - ALLCATEGORY
                - RECENTPOST
                maxLength: 100
                minLength: 0
            required:
            - landingPage
          examples:
            Valid requestBody Definitions:
              value:
                landingPage: ALL_CATEGORY
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter