Zoho: Duplicate check preference schemas
7 Zoho schemas with complete fields and constraints.
← Duplicate check preference operations · All 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 |
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 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 |
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 |