Zoho: Convert schemas
11 Zoho schemas with complete fields and constraints.
← Convert operations · All schemas
Convert a Lead — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Wrapper object containing array of conversion requests Additional keys: not allowed |
data | array | Required within parent | Array of lead conversion configurations Maximum items: 100 |
data[] | Model | Each item | Expand Convert a Lead — request body — body data item |
Referenced models: Convert a Lead — request body — body data item
Convert a Lead — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration for converting a single lead Additional keys: not allowed |
Deals | Model | Optional | Expand Convert a Lead — request body — body data item Deals |
add_to_existing_record | boolean | Optional | When true, associates the Lead with an existing Account or Contact instead of creating duplicates. |
assign_to | object | Optional | Assigns a record owner for the new Contact and Account after lead conversion. It ensures that the converted lead is assigned to a specific user in Zoho CRM. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve valid User IDs. Additional keys: not allowed |
assign_to.id | string | Required within parent | Zoho CRM user ID (int64 as string) Maximum length: 20 |
carry_over_tags | object | Optional | Configuration for carrying over tags from the Lead to converted records Additional keys: not allowed |
carry_over_tags.Accounts | object | Optional | Tag carryover settings for Account records Additional keys: allowed |
carry_over_tags.Contacts | object | Optional | Tag carryover settings for Contact records. Additional keys: allowed |
carry_over_tags.Deals | object | Optional | Tag carryover settings for Deal records Additional keys: allowed |
default | JSON | Optional | |
notify_lead_owner | boolean | Optional | If true, sends email notification to the Lead owner about the conversion. Default is false. Default: false |
notify_new_entity_owner | boolean | Optional | If true, notifies the owner(s) of newly created Contact, Account, or Deal records. Default is false. Default: false |
overwrite | boolean | Optional | Determines whether to overwrite the Account Name in a Contact when converting a Lead. For example, If a Contact is already linked to an Account but the Lead’s Company name is different, enabling this option will update the Contact’s Account to match the Lead’s Company. **Possible values:** false (default) : Keeps the existing Account Name in the Contact unchanged. true : Updates the Contact’s associated Account Name if it differs from the Company name in the Lead. |
Referenced models: Convert a Lead — request body — body data item Deals
Convert a Lead — request body — body data item Deals
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deal record configuration for lead conversion Additional keys: not allowed |
$move_attachments | boolean | Optional | If true, moves attachments from the Lead to the Deal |
Amount | number | Optional | Expected revenue amount for the Deal Format: double |
Campaign_Source | string | Optional | Campaign source associated with this Deal Maximum length: 100 |
Closing_Date | string | Required within parent | Expected closing date for the Deal (ISO 8601 date format: YYYY-MM-DD) Format: date |
Contact_Role | string | Optional | Represents the **role** of the Contact in this Deal Maximum length: 50 |
Deal_Name | string | Required within parent | Specify the name of the Deal Maximum length: 120 |
Description | string | Optional | Detailed description of the Deal Maximum length: 32000 |
Lead_Source | string | Optional | Source from which the Lead originated Maximum length: 100 |
Next_Step | string | Optional | Next action or milestone for the Deal Maximum length: 200 |
Pipeline | string | Required within parent | Indicates the **sales pipeline** for the Deal. Must match an existing pipeline in the CRM. Maximum length: 100 |
Probability | integer | Optional | Win probability percentage (0-100) Format: int32 Maximum: 100 Minimum: 0 |
Stage | string | Required within parent | Current stage of the Deal within the specified Pipeline. Must be valid for the chosen Pipeline. Maximum length: 100 |
Type | string | Optional | Type of Deal (e.g., New Business, Existing Business) Maximum length: 50 |
Convert a Lead — response body — Wrapper for successful conversion response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Wrapper for successful conversion response Additional keys: not allowed |
data | array | Required within parent | Array of conversion results Maximum items: 100 |
data[] | Model | Each item | Expand Convert a Lead — response body — Wrapper for successful conversion response data item |
Referenced models: Convert a Lead — response body — Wrapper for successful conversion response data item
Convert a Lead — response body — Wrapper for successful conversion response data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Successful lead conversion result Additional keys: not allowed |
code | string | Required within parent | Status code indicating successful conversion Known values: SUCCESS |
details | Model | Required within parent | Expand Convert a Lead — response body — Wrapper for successful conversion response data item details |
message | string | Required within parent | Message that summarizes the outcome of the lead conversion request. Maximum length: 500 |
status | string | Required within parent | Overall status of the conversion operation Known values: success |
Referenced models: Convert a Lead — response body — Wrapper for successful conversion response data item details
Convert a Lead — response body — Wrapper for successful conversion response data item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of created records including their IDs and names. Additional keys: not allowed |
Accounts | JSON | Required within parent | Account record information, or null if no Account was created |
Accounts (anyOf 1) | Model | Alternative | Expand Convert a Lead — response body — Wrapper for successful conversion response data item details Contacts |
Accounts (anyOf 2) | null | Alternative | No Account was created during conversion |
Contacts | Model | Required within parent | Expand Convert a Lead — response body — Wrapper for successful conversion response data item details Contacts |
Deals | JSON | Required within parent | Deal record information, or null if no Deal was created |
Deals (anyOf 1) | Model | Alternative | Expand Convert a Lead — response body — Wrapper for successful conversion response data item details Contacts |
Deals (anyOf 2) | null | Alternative | No Deal was created during conversion |
Referenced models: Convert a Lead — response body — Wrapper for successful conversion response data item details Contacts
Convert a Lead — response body — Wrapper for successful conversion response data item details Contacts
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to a CRM entity with ID and name Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the entity record (int64 as string) Maximum length: 20 |
name | string | Required within parent | Represents the name of the entity. Maximum length: 200 |
Convert a Lead — response body — value Wrapper for scheduled conversion response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Wrapper for scheduled conversion response Additional keys: not allowed |
data | array | Required within parent | Array containing the scheduled job information Maximum items: 1 |
data[] | Model | Each item | Expand Convert a Lead — response body — value Wrapper for scheduled conversion response data item |
Referenced models: Convert a Lead — response body — value Wrapper for scheduled conversion response data item
Convert a Lead — response body — value Wrapper for scheduled conversion response data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Lead conversion scheduled for background processing Additional keys: not allowed |
code | string | Required within parent | Status code indicating conversion was scheduled Known values: SCHEDULED |
details | object | Required within parent | Job details Additional keys: not allowed |
details.job_id | string | Required within parent | Unique job identifier Maximum length: 20 |
message | string | Required within parent | Message that summarizes the scheduling result for the lead conversion request. Maximum length: 500 |
status | string | Required within parent | Overall status Known values: success |
Convert a Lead — response body — value Wrapper for validation error responses
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Wrapper for validation error responses Additional keys: not allowed |
data | array | Required within parent | Array of validation errors Maximum items: 100 |
data[] | Model | Each item | Expand Convert a Lead — response body — value Wrapper for validation error responses data item |
Referenced models: Convert a Lead — response body — value Wrapper for validation error responses data item
Convert a Lead — response body — value Wrapper for validation error responses data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Validation error details Additional keys: not allowed |
code | string | Required within parent | Error code identifying the type of validation failure Known values: MANDATORY_NOT_FOUND, MAPPING_MISMATCH, INVALID_DATA, DUPLICATE_DATA, CANNOT_PERFORM_ACTION, NOT_ALLOWED, NOT_REVIEWED |
details | object | Required within parent | Additional error context and affected field information Additional keys: allowed |
details.api_name | string | Optional | API name of the affected field Maximum length: 100 |
details.expected_data_type | string | Optional | Expected data type for the field Maximum length: 50 |
details.json_path | string | Optional | JSONPath to the affected field in the request Maximum length: 200 |
details.mapped_field | string | Optional | Name of the field that has a mapping relationship Maximum length: 100 |
details.maximum_length | JSON | Optional | |
details.maximum_length (anyOf 1) | integer | Alternative | Maximum allowed length for the field Format: int32 |
details.maximum_length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Message that explains why the lead conversion request failed validation. Maximum length: 500 |
status | string | Required within parent | Error status indicator Known values: error |