Zoho: Get Duplicate Check Preference

← Duplicate check preference operations · Get started

Operation zoho.getduplicatecheckpreference

Provider route: GET /crm/v8/settings/duplicate_check_preference. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["duplicateCheckPreference"]["getDuplicateCheckPreference"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.duplicateCheckPreference.getDuplicateCheckPreference(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.duplicate_check_preference.get_duplicate_check_preference(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	One of: Leads

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get Duplicate Check Preference — response body — Schema for getting duplicate check preference
$ (anyOf 2)	null	Alternative

Referenced models: Get Duplicate Check Preference — response body — Schema for getting duplicate check preference

Schemas

Get Duplicate Check Preference — response body — Schema for getting duplicate check preference

Field	Type	Presence	Description and constraints
$	object	Root	Schema for getting duplicate check preference. Additional keys: not allowed
duplicate_check_preference	object	Required within parent	Duplicate check preference details. Additional keys: not allowed
duplicate_check_preference.type	string	Required within parent	Type of duplicate check preference. Known values: converted_records, mapped_module_records
duplicate_check_preference.type_configurations	JSON	Required within parent
duplicate_check_preference.type_configurations (anyOf 1)	array	Alternative	Configurations for the duplicate check preference type Maximum items: 1
duplicate_check_preference.type_configurations (anyOf 1)[]	Model	Each item	Expand Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item
duplicate_check_preference.type_configurations (anyOf 2)	null	Alternative	Configurations for the duplicate check preference type Maximum items: 1
duplicate_check_preference.type_configurations (anyOf 2)[]	Model	Each item	Expand Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item

Referenced models: Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item

Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item

Field	Type	Presence	Description and constraints
$	object	Root	Type configuration details. Additional keys: not allowed
field_mappings	array	Required within parent	Field mappings for duplicate check.
field_mappings[]	Model	Each item	Expand Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item
mapped_module	Model	Required within parent	Expand Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item mapped module

Referenced models: Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item, Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item mapped module

Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item

Field	Type	Presence	Description and constraints
$	object	Root	Field mapping details. Additional keys: not allowed
current_field	Model	Required within parent	Expand Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item current field
mapped_field	Model	Required within parent	Expand Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item mapped field

Referenced models: Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item current field, Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item mapped field

Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item mapped module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the mapped module details. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the module. Known values: Contacts
id	string	Required within parent	Represents the unique identifier of the module. Maximum length: 50
name	string	Required within parent	Represents the display name of the module. Known values: Contacts

Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item current field

Field	Type	Presence	Description and constraints
$	object	Root	Current field details. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the unique field in the Leads module. Use the [Get Fields Metadata API](fields.json#$.paths./settings/fields.get) to retrieve the API names of the unique fields. Maximum length: 50
id	string	Required within parent	Represents the unique identifier of the field. Use the [Get Fields Metadata API](fields.json#$.paths./settings/fields.get) to retrieve the unique ID fields. Maximum length: 50
name	string	Required within parent	Represents the module that the field belongs to, not the field's own display name. The API returns `Leads` for `current_field` and `Contacts` for `mapped_field`. Maximum length: 50

Get Duplicate Check Preference — response body — Schema for getting duplicate check preference duplicate check preference type configurations null item field mappings item mapped field

Field	Type	Presence	Description and constraints
$	object	Root	Mapped field details. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the mapped field. Maximum length: 50
id	string	Required within parent	Represents the unique identifier of the mapped field. Maximum length: 50
name	string	Required within parent	Represents the module that the mapped field belongs to, not the field's own display name. The API returns `Contacts`. Maximum length: 50

Policy, approvals and errors

SDK function policy ID: zoho.getduplicatecheckpreference. Catalog operation: getDuplicateCheckPreference. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source