Zoho: Create Duplicate Check Preference

← Duplicate check preference operations · Get started

Operation zoho.createduplicatecheckpreference

Provider route: POST /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"]["createDuplicateCheckPreference"]>[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.createDuplicateCheckPreference(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.create_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
body	Model	Required within parent	Expand Create Duplicate Check Preference — request body — body

Referenced models: Create Duplicate Check Preference — request body — body

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
$	object	Root	Response wrapper object containing the duplicate check preference details. Additional keys: not allowed
duplicate_check_preference	object	Required within parent	Details of the duplicate check preference configuration. Additional keys: not allowed
duplicate_check_preference.code	string	Optional	Status code indicating the result of the operation. Known values: SUCCESS
duplicate_check_preference.details	object	Optional	Additional details related to the operation. Additional keys: not allowed
duplicate_check_preference.message	string	Optional	Represents the message providing additional information about the operation result. Maximum length: 100
duplicate_check_preference.status	string	Optional	Status of the operation. Known values: success

Schemas

Create Duplicate Check Preference — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload used to create 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. One of: converted_records, mapped_module_records
duplicate_check_preference.type_configurations	array or null	Optional	Configurations for the duplicate check preference type. Mandatory when type is mapped_module_records and ignored when type is converted_records. Only the first entry is processed. Maximum items: 1
duplicate_check_preference.type_configurations[]	object	Each item	Type configuration details. Additional keys: not allowed
duplicate_check_preference.type_configurations[].field_mappings	array	Required within parent	Field mappings for duplicate check.
duplicate_check_preference.type_configurations[].field_mappings[]	object	Each item	Field mapping details. Additional keys: not allowed
duplicate_check_preference.type_configurations[].field_mappings[].current_field	object	Required within parent	Unique field in the Leads module to match on. Additional keys: not allowed
duplicate_check_preference.type_configurations[].field_mappings[].current_field.api_name	string	Optional	Represents the API name of the unique field in the Leads module. Validated when supplied, but the mapping is stored against id. Maximum length: 50
duplicate_check_preference.type_configurations[].field_mappings[].current_field.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. The mapping is stored against this id, so it is mandatory. Maximum length: 50
duplicate_check_preference.type_configurations[].field_mappings[].current_field.name	string	Optional	Accepted for symmetry with the response and ignored by the API. Maximum length: 50
duplicate_check_preference.type_configurations[].field_mappings[].mapped_field	object	Required within parent	Unique field in the mapped module to match against. Additional keys: not allowed
duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.api_name	string	Optional	Represents the API name of the mapped field. Validated when supplied, but the mapping is stored against id. Maximum length: 50
duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.id	string	Required within parent	Represents the unique identifier of the mapped field. The mapping is stored against this id, so it is mandatory. Maximum length: 50
duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.name	string	Optional	Accepted for symmetry with the response and ignored by the API. Maximum length: 50
duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.selected	string	Optional	Send None to skip this field mapping. Any other value, or omitting the property, creates the mapping. One of: None Maximum length: 4
duplicate_check_preference.type_configurations[].mapped_module	object	Required within parent	Represents the mapped module details. Mandatory when type is mapped_module_records. Additional keys: not allowed
duplicate_check_preference.type_configurations[].mapped_module.api_name	string	Optional	Represents the API name of the module. Validated when supplied, but the module is resolved from id. One of: Contacts
duplicate_check_preference.type_configurations[].mapped_module.id	string	Required within parent	Represents the unique identifier of the module. The module must resolve to Contacts. Maximum length: 50
duplicate_check_preference.type_configurations[].mapped_module.name	string	Optional	Accepted for symmetry with the response and ignored by the API. Maximum length: 50

Policy, approvals and errors

SDK function policy ID: zoho.createduplicatecheckpreference. Catalog operation: createDuplicateCheckPreference. 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.

Official provider source