Zoho Routing Preference API

The RoutingPreference API from Zoho — 1 operation(s) for routingpreference.

Operations 2

GET /api/v1/routingPreferences Get Routing Preferences #
PATCH /api/v1/routingPreferences Update Routing Preferences #

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-routingpreference-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-routingpreference-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Helpcenter Routing Preference API
  version: 1.0.0
tags:
- name: RoutingPreference
paths:
  /api/v1/routingPreferences:
    get:
      tags:
      - RoutingPreference
      summary: Get Routing Preferences
      description: This API is used to Get the Routing Preferences for a Department
      operationId: getRoutingPreference
      parameters:
      - name: departmentId
        in: query
        description: Department Id
        required: true
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int64
          description: Department Id
          pattern: ([0-9]+)
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '200':
          $ref: '#/components/responses/getRoutingPreferenceResponseJson'
      security:
      - iam-oauth2-schema:
        - Desk.settings.READ
      x-audience:
      - external-public
    patch:
      tags:
      - RoutingPreference
      summary: Update Routing Preferences
      description: This API is used to Update the Routing Preferences for a Department
      operationId: updateRoutingPreference
      parameters:
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/updateRoutingPreferenceJsonPayload'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '200':
          $ref: '#/components/responses/updateRoutingPreferenceJson'
      security:
      - iam-oauth2-schema:
        - Desk.settings.UPDATE
      x-audience:
      - external-public
components:
  requestBodies:
    updateRoutingPreferenceJsonPayload:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              assignBacklog:
                type:
                - boolean
                - 'null'
              assignToOfflineAgents:
                type:
                - boolean
                - 'null'
              thresholdLimit:
                type:
                - string
                - 'null'
                - integer
                format: int32
                pattern: ([0-9]+)
              backLogLimit:
                type:
                - string
                - 'null'
                - integer
                format: int32
                pattern: ([0-9]+)
              isThresholdEnabled:
                type:
                - boolean
                - 'null'
              isImmediateAssignmentEnabled:
                type:
                - boolean
                - 'null'
              departmentId:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              assignBacklogsBy:
                type:
                - string
                - 'null'
                enum:
                - DUEDATE
                - CREATEDTIME
                maxLength: 100
                minLength: 0
              freshTicketAssignMode:
                type:
                - string
                - 'null'
                enum:
                - IMMEDIATE
                - MOVE_TO_BACKLOG
                maxLength: 100
                minLength: 0
              customThresholdVsAgents:
                type:
                - 'null'
                - array
                items:
                  type:
                  - 'null'
                  - object
                  additionalProperties: false
                  maxProperties: 2
                  minProperties: 2
                  properties:
                    agentIds:
                      type:
                      - 'null'
                      - array
                      items:
                        type:
                        - string
                        - 'null'
                        - integer
                        format: int64
                        pattern: ([0-9]+)
                      uniqueItems: false
                    customThreshold:
                      type:
                      - string
                      - 'null'
                      - integer
                      format: int32
                      pattern: ([0-9]+)
                  required:
                  - agentIds
                  - customThreshold
                maxItems: 1
                uniqueItems: true
              isCustomThresholdEnabled:
                type:
                - boolean
                - 'null'
            required:
            - departmentId
          examples:
            Valid requestBody Definitions:
              value:
                assignBacklog: true
                isThresholdEnabled: 'true'
                backLogLimit: '22'
                departmentId: '1000000013248'
  responses:
    getRoutingPreferenceResponseJson:
      description: getRoutingPreferenceResponseJson template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              assignBacklog:
                type:
                - boolean
                - 'null'
              assignToOfflineAgents:
                type:
                - boolean
                - 'null'
              thresholdLimit:
                type:
                - string
                - 'null'
                - integer
                format: int32
                pattern: ([0-9]+)
              backLogLimit:
                type:
                - string
                - 'null'
                - integer
                format: int32
                pattern: ([0-9]+)
              isThresholdEnabled:
                type:
                - boolean
                - 'null'
              isImmediateAssignmentEnabled:
                type:
                - boolean
                - 'null'
              departmentId:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              assignBacklogsBy:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
              freshTicketAssignMode:
                type:
                - string
                - 'null'
                enum:
                - IMMEDIATE
                - MOVE_TO_BACKLOG
                maxLength: 100
                minLength: 0
              customThresholdVsAgents:
                $ref: ./RoutingPreference.json#/components/schemas/customThresholdVsAgentsList
              schedulerInfo:
                $ref: ./RoutingPreference.json#/components/schemas/schedulerInfo
              isCustomThresholdEnabled:
                type:
                - boolean
                - 'null'
            required:
            - assignBacklog
            - assignBacklogsBy
            - assignToOfflineAgents
            - backLogLimit
            - customThresholdVsAgents
            - departmentId
            - freshTicketAssignMode
            - isCustomThresholdEnabled
            - isImmediateAssignmentEnabled
            - isThresholdEnabled
            - thresholdLimit
          examples:
            Valid responses Definitions:
              value:
                assignBacklog: true
                assignToOfflineAgents: true
                thresholdLimit: '40'
                backLogLimit: '5'
                isThresholdEnabled: true
                departmentId: '1000000013248'
                assignBacklogsBy: DUEDATE
                freshTicketAssignMode: IMMEDIATE
    updateRoutingPreferenceJson:
      description: updateRoutingPreferenceJson template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              assignBacklog:
                type:
                - boolean
                - 'null'
              assignToOfflineAgents:
                type:
                - boolean
                - 'null'
              thresholdLimit:
                type:
                - string
                - 'null'
                - integer
                format: int32
                pattern: ([0-9]+)
              backLogLimit:
                type:
                - string
                - 'null'
                - integer
                format: int32
                pattern: ([0-9]+)
              isThresholdEnabled:
                type:
                - boolean
                - 'null'
              departmentId:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              assignBacklogsBy:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
              freshTicketAssignMode:
                type:
                - string
                - 'null'
                enum:
                - IMMEDIATE
                - MOVE_TO_BACKLOG
                maxLength: 100
                minLength: 0
            required:
            - assignBacklog
            - assignBacklogsBy
            - assignToOfflineAgents
            - backLogLimit
            - departmentId
            - freshTicketAssignMode
            - isThresholdEnabled
            - thresholdLimit
          examples:
            Valid responses Definitions:
              value:
                assignBacklog: true
                assignToOfflineAgents: true
                thresholdLimit: '40'
                backLogLimit: '22'
                isThresholdEnabled: true
                departmentId: '1000000013248'
                assignBacklogsBy: DUEDATE
                freshTicketAssignMode: IMMEDIATE
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter