Disable Duplicate Check Option

Purpose

To disable the Duplicate Check Preference option.

Endpoints

  • DELETE /settings/duplicate_check_preference?module={module_api_name}

Request Details

Request URL

{api-domain}/crm/{version}/settings/duplicate_check_preference

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope = ZohoCRM.settings.ALL  (or)
scope = ZohoCRM.settings.duplicate_check_preference.{operation_type} 

Possible operation types

ALL - Full data access 
DELETE - Disable duplicate record check preference 

Supported module

Leads 

Parameter

  • modulestring, mandatory

     Specify the API name of the Leads module to disable the "Duplicate Check Preference" option. Supported module: Leads. 

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/duplicate_check_preference?module=Leads"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxd"

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL.
    Specify a valid request method. Refer to the endpoints section above.

  • NOT_SUPPORTEDHTTP 400

    This API does not support the given module 
    Resolution: Please specify the supported module. Supported Module : Leads

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: The client does not have a valid scope to disable duplicate check preference option. Create a new token with the required scopes. Refer to the scope section above.

  • AUTHENTICATION_FAILUREHTTP 401

    Authentication failed
    Resolution: Pass the access token in the request header of the API call.

  • FEATURE_NOT_SUPPORTEDHTTP 400

    Feature not enabled
    Resolution: Enable the Duplicate Check Preference Option, using the Enable Duplicate Record Check Option API.

  • NO_PERMISSIONHTTP 403

    No permission to access the module
    Resolution: Contact the administrator.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Referto the request URL section above.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response for disabling Duplicate Check Preference Option for "Converted Leads"

Copied{
    "duplicate_check_preference": {
        "code": "SUCCESS",
        "details": {},
        "message": "Duplicate check disabled for converted_records successfully.",
        "status": "success"
    }
}

Sample Response for disabling Duplicate Check Preference Option for "Contacts"

Copied{
    "duplicate_check_preference": {
        "code": "SUCCESS",
        "details": {},
        "message": "Duplicate check disabled for mapped_module_records successfully.",
        "status": "success"
    }
}