> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Duplicate Check Preference Get Duplicate Check Preference

> Get the duplicate check rule for a Zoho CRM module, showing which fields identify duplicates. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get the duplicate check rule for a Zoho CRM module, showing which fields identify duplicates.

> [!NOTE]
>
> Tool ID: `zoho_crm_duplicate_check_preference_get_duplicate_check_preference`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_duplicate_check_preference_get_duplicate_check_preference',
  {
    "module": "Leads"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_duplicate_check_preference_get_duplicate_check_preference --input '{
  "module": "Leads"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe zoho_crm_duplicate_check_preference_get_duplicate_check_preference --json` for the complete live contract.

## Input reference

Get Duplicate Check Preference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `"Leads"` | Yes | — | The API name of the module for which to manage duplicate check preferences. Example: Leads Allowed: `Leads`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get Duplicate Check Preference",
    "properties": {
      "module": {
        "type": "string",
        "description": "The API name of the module for which to manage duplicate check preferences. Example: Leads",
        "enum": [
          "Leads"
        ]
      }
    },
    "required": [
      "module"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Schema for getting duplicate check preference |
| `result.data.duplicate_check_preference` | `object` | Yes | — | Duplicate check preference details |
| `result.data.duplicate_check_preference.type` | `"converted_records" \| "mapped_module_records"` | Yes | — | Type of duplicate check preference Allowed: `converted_records`, `mapped_module_records`. |
| `result.data.duplicate_check_preference.type_configurations` | `array` | Yes | — | Configurations for the duplicate check preference type Maximum items: 1. |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings` | `array` | Yes | — | Field mappings for duplicate check Maximum items: 5. |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].current_field` | `object` | Yes | — | Current field details |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].current_field.id` | `string` | Yes | — | Unique identifier of the field Maximum length: 50. |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].current_field.api_name` | `string` | Yes | — | API name of the field Maximum length: 50. |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].current_field.name` | `string` | Yes | — | Display name of the field Maximum length: 100. |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].mapped_field` | `object` | Yes | — | Mapped field details |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.id` | `string` | Yes | — | Unique identifier of the mapped field Maximum length: 50. |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.api_name` | `string` | Yes | — | API name of the mapped field Maximum length: 50. |
| `result.data.duplicate_check_preference.type_configurations[].field_mappings[].mapped_field.name` | `string` | Yes | — | Display name of the mapped field Maximum length: 100. |
| `result.data.duplicate_check_preference.type_configurations[].mapped_module` | `object` | Yes | — | Mapped module details |
| `result.data.duplicate_check_preference.type_configurations[].mapped_module.id` | `string` | Yes | — | Unique identifier of the module Maximum length: 50. |
| `result.data.duplicate_check_preference.type_configurations[].mapped_module.api_name` | `"Contacts"` | Yes | — | API name of the module Allowed: `Contacts`. |
| `result.data.duplicate_check_preference.type_configurations[].mapped_module.name` | `"Contacts"` | Yes | — | Display name of the module Allowed: `Contacts`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Schema for getting duplicate check preference",
        "properties": {
          "duplicate_check_preference": {
            "type": "object",
            "description": "Duplicate check preference details",
            "properties": {
              "type": {
                "type": "string",
                "description": "Type of duplicate check preference",
                "enum": [
                  "converted_records",
                  "mapped_module_records"
                ]
              },
              "type_configurations": {
                "type": "array",
                "description": "Configurations for the duplicate check preference type",
                "maxItems": 1,
                "items": {
                  "type": "object",
                  "description": "Type configuration details",
                  "properties": {
                    "field_mappings": {
                      "type": "array",
                      "description": "Field mappings for duplicate check",
                      "maxItems": 5,
                      "items": {
                        "type": "object",
                        "description": "Field mapping details",
                        "properties": {
                          "current_field": {
                            "type": "object",
                            "description": "Current field details",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Unique identifier of the field",
                                "maxLength": 50
                              },
                              "api_name": {
                                "type": "string",
                                "description": "API name of the field",
                                "maxLength": 50
                              },
                              "name": {
                                "type": "string",
                                "description": "Display name of the field",
                                "maxLength": 100
                              }
                            },
                            "required": [
                              "id",
                              "api_name",
                              "name"
                            ],
                            "additionalProperties": false
                          },
                          "mapped_field": {
                            "type": "object",
                            "description": "Mapped field details",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Unique identifier of the mapped field",
                                "maxLength": 50
                              },
                              "api_name": {
                                "type": "string",
                                "description": "API name of the mapped field",
                                "maxLength": 50
                              },
                              "name": {
                                "type": "string",
                                "description": "Display name of the mapped field",
                                "maxLength": 100
                              }
                            },
                            "required": [
                              "id",
                              "api_name",
                              "name"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "current_field",
                          "mapped_field"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "mapped_module": {
                      "type": "object",
                      "description": "Mapped module details",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier of the module",
                          "maxLength": 50
                        },
                        "api_name": {
                          "type": "string",
                          "description": "API name of the module",
                          "enum": [
                            "Contacts"
                          ]
                        },
                        "name": {
                          "type": "string",
                          "description": "Display name of the module",
                          "enum": [
                            "Contacts"
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "api_name",
                        "name"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "field_mappings",
                    "mapped_module"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "type",
              "type_configurations"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "duplicate_check_preference"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.