Zoho

Zoho Settings API

The Settings API from Zoho — 107 operation(s) for settings.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/
📖
GettingStarted
https://www.zoho.com/crm/developer/docs/
📖
Documentation
https://desk.zoho.com/DeskAPIDocument
📖
Documentation
https://www.zoho.com/analytics/api/v2/introduction.html
📖
APIReference
https://www.zoho.com/analytics/api/v2/
📖
Documentation
https://www.bigin.com/developer/docs/apis/v2/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-settings-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-Sample-apps-iOS
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-android
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-flutter
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-reactnative
💻
CodeExamples
https://github.com/zoho/Zoho-Desk-ASAP-Mobile-SDK-API-Samples
💻
CodeExamples
https://github.com/zoho/analytics-codestudio

Other Resources

🔗
SDKs
https://packagist.org/packages/zohocrm/php-sdk-8.0
🔗
SDKs
https://pypi.org/project/zohocrmsdk8-0/
🔗
SDKs
https://www.nuget.org/packages/ZOHOCRMSDK-8.0/
🔗
SDKs
https://github.com/zoho/zohocrm-java-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/nodejs-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/typescript-sdk-8.0
🔗
SDKs
https://rubygems.org/gems/ZOHOCRMSDK8_0
🔗
SDKs
https://github.com/zoho/zohocrm-javascript-sdk-8.0
🔗
SDKs
https://github.com/zoho/zohocrm-scala-sdk-8.0
🔗
SDKs
https://cocoapods.org/pods/ZCRMiOS
🔗
DeveloperPortal
https://www.zoho.com/desk/developers/
🔗
SDKs
https://github.com/zoho/ZohoDeskPortalSDK
🔗
SDKs
https://github.com/zoho/react-native-zohodesk-portal-sdk
🔗
SDKs
https://github.com/zoho/zdesk-asap-flutter
🔗
SDKs
https://github.com/zoho/cordova-plugin-zohodesk-portal
🔗
Tools
https://github.com/zoho/analytics-mcp-server
🔗
Integrations
https://github.com/zoho/analytics-dataiku-import-plugin
🔗
Integrations
https://github.com/zoho/analytics-dataiku-export-plugin
🔗
DeveloperPortal
https://www.bigin.com/developer-center.html

OpenAPI Specification

zoho-settings-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter Settings API
  version: 1.0.0
tags:
- name: Settings
paths:
  /settings/duplicate_check_preference:
    get:
      summary: Get Duplicate Check Preference
      description: Get Duplicate Check Preference
      security:
      - iam-oauth2-schema:
        - ZohoCRM.settings.duplicate_check_preference.READ
      operationId: getDuplicateCheckPreference
      parameters:
      - $ref: '#/components/parameters/Module'
      responses:
        '200':
          description: Successful response with Duplicate Check Preference details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDuplicateCheckPreference'
                x-zs-$id: GetDuplicateCheckPreference
        '204':
          description: If feature not enabled for the given module
      tags:
      - Settings
    post:
      summary: Create Duplicate Check Preference
      description: Create Duplicate Check Preference
      security:
      - iam-oauth2-schema:
        - ZohoCRM.settings.duplicate_check_preference.CREATE
      operationId: createDuplicateCheckPreference
      parameters:
      - $ref: '#/components/parameters/Module'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDuplicateCheckPreference'
        required: true
      responses:
        '200':
          description: Successful response with Duplicate Check Preference details
          content:
            application/json:
              schema:
                description: Response wrapper object containing the duplicate check preference details.
                additionalProperties: false
                type: object
                properties:
                  duplicate_check_preference:
                    description: Details of the duplicate check preference configuration.
                    additionalProperties: false
                    type: object
                    properties:
                      code:
                        description: Status code indicating the result of the operation.
                        type: string
                        enum:
                        - SUCCESS
                      status:
                        description: Status of the operation.
                        type: string
                        enum:
                        - success
                      message:
                        description: Human-readable message providing additional information about the operation result.
                        maxLength: 100
                        type: string
                      details:
                        description: Additional details related to the operation.
                        additionalProperties: false
                        type: object
                required:
                - duplicate_check_preference
        '400':
          description: Bad Request - Invalid input or missing required parameters
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Request-level error format (returned when request param is fundamentally malformed, e.g., missing 'module' parameter).
                  additionalProperties: false
                  properties:
                    status:
                      type: string
                      enum:
                      - error
                      description: Error status indicator.
                    code:
                      type: string
                      enum:
                      - REQUIRED_PARAM_MISSING
                      description: Machine-readable error code for request-level failures.
                    message:
                      type: string
                      enum:
                      - One of the expected parameter is missing.
                      description: Human-readable error message.
                    details:
                      type: object
                      additionalProperties: false
                      description: Contextual error details including field location.
                      properties:
                        param_name:
                          type: string
                          maxLength: 10
                          description: param_name that caused the error (e.g., 'module').
                      required:
                      - param_name
                  required:
                  - status
                  - code
                  - message
                  - details
                - type: object
                  description: Request-level error format (returned when feature not supported).
                  additionalProperties: false
                  properties:
                    status:
                      type: string
                      enum:
                      - error
                      description: Error status indicator.
                    code:
                      type: string
                      enum:
                      - FEATURE_NOT_SUPPORTED
                      description: Machine-readable error code for request-level failures.
                    message:
                      type: string
                      enum:
                      - Your License does not support this feature.
                      description: Human-readable error message.
                    details:
                      type: object
                      additionalProperties: false
                      description: Contextual error details including field location.
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  description: Request-level error format (returned when feature not supported).
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      enum:
                      - NOT_SUPPORTED
                      description: Machine-readable error code for request-level failures.
                    message:
                      type: string
                      enum:
                      - The feature not avilable in the given module.
                      description: Human-readable error message.
                    details:
                      type: object
                      additionalProperties: false
                      description: Contextual error details including field location.
                      properties:
                        param_name:
                          type: string
                          maxLength: 10
                          description: param_name that caused the error (e.g., 'module').
                        api_name:
                          type: string
                          maxLength: 10
                          description: API name of the field with invalid data.
                        json_path:
                          type: string
                          maxLength: 100
                          description: JSONPath to the location of the invalid field.
                      required:
                      - param_name
                      - api_name
                      - json_path
                  required:
                  - code
                  - message
                  - details
                - type: object
                  description: Request-level error format (returned when feature not supported).
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      enum:
                      - ALREADY_CONFIGURED
                      description: Machine-readable error code for request-level failures.
                    message:
                      type: string
                      enum:
                      - already configured.
                      description: Human-readable error message.
                    details:
                      type: object
                      additionalProperties: false
                      description: Contextual error details including field location.
                  required:
                  - code
                  - message
                - type: object
                  description: AMBIGUITY_DURING_PROCESSING error response when conflicting parameters are provided (ids + api_names, or type + restricted_action).
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating parameter ambiguity.
                      enum:
                      - AMBIGUITY_DURING_PROCESSING
                    details:
                      type: object
                      description: Details about the ambiguous parameters.
                      additionalProperties: false
                      properties:
                        ambiguity_due_to:
                          type: array
                          maxItems: 2
                          description: Array of conflicting parameters that caused the ambiguity.
                          items:
                            type: object
                            description: Parameter that contributed to the ambiguity.
                            additionalProperties: false
                            properties:
                              api_name:
                                type: string
                                maxLength: 10
                                description: API field name that caused the error (e.g., 'tab_groups').
                              json_path:
                                type: string
                                maxLength: 100
                                description: JSONPath expression locating the error (e.g., '$.tab_groups').
                            required:
                            - api_name
                            - json_path
                      required:
                      - ambiguity_due_to
                    message:
                      type: string
                      description: Human-readable error message explaining the ambiguity.
                      maxLength: 1000
                    status:
                      type: string
                      description: Error status indicator.
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: MANDATORY_NOT_FOUND error when required fields are missing
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating a mandatory field is missing
                      enum:
                      - MANDATORY_NOT_FOUND
                    details:
                      type: object
                      description: Error details with field location information
                      additionalProperties: false
                      properties:
                        api_name:
                          type: string
                          maxLength: 50
                          description: Name of the required field that is missing
                        json_path:
                          type: string
                          description: JSONPath expression locating where the field should be in the request
                          maxLength: 100
                      required:
                      - api_name
                      - json_path
                    message:
                      type: string
                      description: Human-readable error message describing the missing required field
                      maxLength: 1000
                    status:
                      type: string
                      description: Error status indicator
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: DEPENDENT_FIELD_MISSING error when dependent configuration is missing
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating a dependent field is missing
                      enum:
                      - DEPENDENT_FIELD_MISSING
                    details:
                      type: object
                      description: Error details with field location information
                      additionalProperties: false
                      properties:
                        api_name:
                          type: string
                          maxLength: 50
                          description: Name of the dependent field that is missing
                        json_path:
                          type: string
                          description: JSONPath expression locating where the field should be in the request
                          maxLength: 100
                      required:
                      - api_name
                      - json_path
                    message:
                      type: string
                      description: Human-readable error message describing the missing dependent field
                      maxLength: 1000
                    status:
                      type: string
                      description: Error status indicator
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: EXPECTED_FIELD_MISSING error for missing expected fields
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code for missing expected field
                      enum:
                      - EXPECTED_FIELD_MISSING
                    details:
                      type: object
                      description: Details about missing expected fields
                      additionalProperties: false
                      properties:
                        expected_fields:
                          type: array
                          maxItems: 10
                          description: List of fields that were expected but missing
                          items:
                            type: object
                            description: Field location details
                            additionalProperties: false
                            properties:
                              api_name:
                                type: string
                                description: API name of the expected field
                                minLength: 1
                                maxLength: 50
                              json_path:
                                type: string
                                description: JSONPath location where field was expected
                                minLength: 1
                                maxLength: 100
                            required:
                            - api_name
                            - json_path
                          minItems: 1
                      required:
                      - expected_fields
                    message:
                      type: string
                      description: Human-readable error message
                      minLength: 1
                      maxLength: 1000
                    status:
                      type: string
                      description: Status indicator for error
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: INVALID_DATA error for data validation failures
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating invalid or malformed data
                      enum:
                      - INVALID_DATA
                    details:
                      type: object
                      description: Error details with field information
                      additionalProperties: false
                      properties:
                        maximum_length:
                          type: integer
                          format: int32
                          description: Maximum allowed length for the field
                        expected_data_type:
                          type: string
                          maxLength: 50
                          description: Expected data type for the field
                        api_name:
                          type: string
                          description: Name of the field with invalid data
                          maxLength: 50
                        json_path:
                          type: string
                          description: JSONPath expression locating the invalid field in the request
                          maxLength: 100
                    message:
                      type: string
                      description: Human-readable error message describing the invalid data
                      maxLength: 1000
                    status:
                      type: string
                      description: Error status indicator
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: NOT_ALLOWED error for operations that are not permitted
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating operation is not allowed
                      enum:
                      - NOT_ALLOWED
                    details:
                      type: object
                      description: Error details with field location information
                      additionalProperties: false
                      properties:
                        api_name:
                          type: string
                          description: Name of the field or operation that is not allowed
                          maxLength: 50
                        json_path:
                          type: string
                          description: JSONPath expression locating the not-allowed field or operation
                          maxLength: 100
                      required:
                      - api_name
                      - json_path
                    message:
                      type: string
                      description: Human-readable error message explaining what is not allowed
                      maxLength: 1000
                    status:
                      type: string
                      description: Error status indicator
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: NOT_SUPPORTED error for unsupported operations
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code for unsupported operation
                      enum:
                      - NOT_SUPPORTED
                    details:
                      type: object
                      description: Additional error details (typically empty)
                      additionalProperties: false
                      properties:
                        param_name:
                          type: string
                          maxLength: 10
                          description: param_name that caused the error (e.g., 'module').
                        api_name:
                          type: string
                          description: Name of the field or operation that is not allowed
                          maxLength: 50
                        json_path:
                          type: string
                          description: JSONPath expression locating the not-allowed field or operation
                          maxLength: 100
                    message:
                      type: string
                      description: Human-readable error message
                      minLength: 1
                      maxLength: 1000
                    status:
                      type: string
                      description: Status indicator for error
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: ALREADY_CONFIGURED error for unsupported operations
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code for unsupported operation
                      enum:
                      - ALREADY_CONFIGURED
                      - NO_PERMISSION
                    details:
                      type: object
                      description: Additional error details (typically empty)
                      additionalProperties: false
                    message:
                      type: string
                      description: Human-readable error message
                      minLength: 1
                      maxLength: 1000
                    status:
                      type: string
                      description: Status indicator for error
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: INVALID_MODULE error for unsupported operations
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code for unsupported operation
                      enum:
                      - INVALID_MODULE
                    details:
                      type: object
                      description: Additional error details (typically empty)
                      additionalProperties: false
                      properties:
                        param_name:
                          type: string
                          maxLength: 10
                          description: param_name that caused the error (e.g., 'module').
                    message:
                      type: string
                      description: Human-readable error message
                      minLength: 1
                      maxLength: 1000
                    status:
                      type: string
                      description: Status indicator for error
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: DEPENDENT_FIELD_MISSING error for unsupported operations
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code for unsupported operation
                      enum:
                      - DEPENDENT_FIELD_MISSING
                    details:
                      type: object
                      description: Additional error details (typically empty)
                      additionalProperties: false
                      properties:
                        dependee:
                          type: object
                          description: param_name that caused the error (e.g., 'module').
                          additionalProperties: false
                          properties:
                            api_name:
                              type: string
                              maxLength: 50
                              description: API name of the dependee field
                            json_path:
                              type: string
                              maxLength: 100
                              description: JSON path of the dependee field
                          required:
                          - api_name
                          - json_path
                        api_name:
                          type: string
                          maxLength: 50
                          description: API name of the dependee field
                        json_path:
                          type: string
                          maxLength: 100
                          description: JSON path of the dependee field
                    message:
                      type: string
                      description: Human-readable error message
                      minLength: 1
                      maxLength: 1000
                    status:
                      type: string
                      description: Status indicator for error
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
      tags:
      - Settings
    put:
      summary: Update Duplicate Check Preference
      description: Update Duplicate Check Preference API is used to update duplicate check settings for a specific module in the CRM system. It allows users to define how duplicate records are identified and managed based on field mappings between the current module and a mapped module, such as Contacts. This API helps maintain data integrity by preventing the creation of duplicate records during data entry or import processes.
      security:
      - iam-oauth2-schema:
        - ZohoCRM.settings.duplicate_check_preference.UPDATE
      operationId: updateDuplicateCheckPreference
      parameters:
      - $ref: '#/components/parameters/Module'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Request Body for Update Duplicate Check Preference
              additionalProperties: false
              properties:
                duplicate_check_preference:
                  type: object
                  description: Duplicate Check Preference details
                  additionalProperties: false
                  properties:
                    type:
                      type: string
                      description: Type of duplicate check preference
                      enum:
                      - mapped_module_records
                      - converted_records
                    type_configurations:
                      type: array
                      description: Type configurations for duplicate check preference
                      maxItems: 1
                      items:
                        type: object
                        description: Type configuration details
                        additionalProperties: false
                        properties:
                          field_mappings:
                            description: Field mappings between current module and mapped module
                            maxItems: 5
                            type: array
                            items:
                              type: object
                              description: Field mapping details
                              additionalProperties: false
                              properties:
                                current_field:
                                  type: object
                                  description: Field mappings between current module and mapped module
                                  additionalProperties: false
                                  properties:
                                    id:
                                      type: string
                                      description: Field mappings between current module and mapped module
                                      maxLength: 50
                                    api_name:
                                      type: string
                                      description: Field mappings between current module and mapped module
                                      maxLength: 50
                                    name:
                                      type: string
                                      description: Field mappings between current module and mapped module
                                      maxLength: 50
                                  required:
                                  - id
                                  - api_name
                                mapped_field:
                                  type: object
                                  description: Mapped field details
                                  additionalProperties: false
                                  properties:
                                    id:
                                      type: string
                                      description: Mapped field id
                                      maxLength: 50
                                    api_name:
                                      type: string
                                      description: Mapped field API name
                                      maxLength: 50
                                    name:
                                      type: string
                                      description: Field mappings between current module and mapped module
                                      maxLength: 50
                                  required:
                                  - id
                                  - api_name
                              required:
                              - current_field
                              - mapped_field
                          mapped_module:
                            type: object
                            description: Mapped module details
                            additionalProperties: false
                            properties:
                              id:
                                type: string
                                description: Mapped module id
                                maxLength: 50
                              name:
                                type: string
                                description: Mapped module id
                                maxLength: 50
                              api_name:
                                type: string
                                description: Mapped module API name
                                maxLength: 50
                                enum:
                                - Contacts
                            required:
                            - id
                            - api_name
                        required:
                        - field_mappings
                        - mapped_module
                  required:
                  - type
                  - type_configurations
              required:
              - duplicate_check_preference
        required: true
      responses:
        '200':
          description: put api success response
      

# --- truncated at 32 KB (2305 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-settings-api-openapi.yml