Zoho: Update Duplicate Check Preference

← Duplicate check preference operations · Get started

Operation zoho.updateduplicatecheckpreference

Provider route: PUT /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"]["updateDuplicateCheckPreference"]>[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.updateDuplicateCheckPreference(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.update_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	object	Required within parent	Represents the request payload used to update duplicate check preference. Additional keys: not allowed
body.duplicate_check_preference	object	Required within parent	Duplicate Check Preference details Additional keys: not allowed
body.duplicate_check_preference.type	string	Required within parent	Type of duplicate check preference One of: mapped_module_records, converted_records
body.duplicate_check_preference.type_configurations	array	Required within parent	Type configurations for duplicate check preference Maximum items: 1
body.duplicate_check_preference.type_configurations[]	object	Each item	Type configuration details Additional keys: not allowed
body.duplicate_check_preference.type_configurations[].field_mappings	array	Required within parent	Field mappings between the current module and the mapped module
body.duplicate_check_preference.type_configurations[].field_mappings[]	object	Each item	Field mapping details Additional keys: not allowed
body.duplicate_check_preference.type_configurations[].field_mappings[].current_field	object	Required within parent	Unique field in the current module to match on Additional keys: not allowed
body.duplicate_check_preference.type_configurations[].field_mappings[].current_field.api_name	string	Optional	API name of the current module field. Validated when supplied, but the mapping is stored against id. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
body.duplicate_check_preference.type_configurations[].field_mappings[].current_field.id	string	Required within parent	Field id of the current module field. The mapping is stored against this id, so it is mandatory. Format: int64
body.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
body.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
body.duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.api_name	string	Optional	Mapped field API name. Validated when supplied, but the mapping is stored against id. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
body.duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.id	string	Required within parent	Represents the ID of the mapped field. The mapping is stored against this id, so it is mandatory. Format: int64
body.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
body.duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.selected	string	Optional	Send None to delete the existing mapping for this current_field. Any other value, or omitting the property, adds or updates the mapping. One of: None Maximum length: 4
body.duplicate_check_preference.type_configurations[].mapped_module	object	Required within parent	Mapped module details Additional keys: not allowed
body.duplicate_check_preference.type_configurations[].mapped_module.api_name	string	Optional	Mapped module API name. Validated when supplied, but the module is resolved from id. Maximum length: 50
body.duplicate_check_preference.type_configurations[].mapped_module.id	string	Required within parent	Represents the ID of the mapped module. The module must resolve to Contacts. Format: int64
body.duplicate_check_preference.type_configurations[].mapped_module.name	string	Optional	Accepted for symmetry with the response and ignored by the API. Maximum length: 50

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	Represents the success response returned after the API updates the duplicate check preference. Additional keys: not allowed
duplicate_check_preference	object	Required within parent	Duplicate Check Preference update response Additional keys: not allowed
duplicate_check_preference.code	string	Optional	Response code for successful update Known values: SUCCESS
duplicate_check_preference.details	object	Optional	Additional details about the update operation Additional keys: allowed
duplicate_check_preference.message	string	Optional	Represents the message regarding the update operation. Maximum length: 1000
duplicate_check_preference.status	string	Optional	Status of the update operation Known values: success

Policy, approvals and errors

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