Zoho: Lead Conversion Options

← Conversion option operations · Get started

Operation zoho.getleadconversionoptions

Provider route: GET /crm/v8/Leads/{leadId}/__conversion_options. 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["conversionOption"]["getLeadConversionOptions"]>[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.conversionOption.getLeadConversionOptions(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.conversion_option.get_lead_conversion_options(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.leadId	string	Required within parent	Format: int64
query	object	Optional	Additional keys: not allowed
query.include_inner_details	string	Optional	Comma-separated list of inner resource paths to include additional details for Maximum length: 256 Minimum length: 1

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
$	JSON	Root
$ (anyOf 1)	object	Alternative	Conversion options response containing available contacts, accounts, and field mappings for lead conversion Additional keys: not allowed
$ (anyOf 1).__conversion_options	object	Optional	Container for all conversion option data Additional keys: not allowed
$ (anyOf 1).__conversion_options.Accounts	JSON	Required within parent	Represents matching Account records for the lead. Returns an array when matches exist, or null when no matching accounts are found.
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)	array	Alternative	Array of existing Account records that match the lead data Maximum items: 100
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[]	object	Each item	Account record with matching lead information Additional keys: not allowed
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].$approval_state	string	Required within parent	Current approval state of the account record Known values: approved, pending, rejected, approval_process_pending, approval_process_rejected
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].$editable	boolean	Required within parent	Indicates if the account record can be edited
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Account_Name	string	Required within parent	Name of the account Maximum length: 200
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Account_Type	JSON	Required within parent	Represents the account type value. Returns the account type when available, or null when the account type is not specified.
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Account_Type (anyOf 1)	string	Alternative	Type of the account Maximum length: 100
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Account_Type (anyOf 2)	null	Alternative	No account type specified
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Locked__s	boolean	Required within parent	Indicates if the account record is locked
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Phone	JSON	Required within parent	Represents the account phone value. Returns a phone number when available, or null when the account has no phone value.
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Phone (anyOf 1)	string	Alternative	Phone number of the account Maximum length: 50
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Phone (anyOf 2)	null	Alternative	No phone number provided
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Website	JSON	Required within parent	Represents the account website value. Returns the website URL when available, or null when the account has no website value.
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Website (anyOf 1)	string	Alternative	Website URL of the account Maximum length: 2000
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].Website (anyOf 2)	null	Alternative	No website URL provided
$ (anyOf 1).__conversion_options.Accounts (anyOf 1)[].id	string	Required within parent	Unique identifier of the account record (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.Accounts (anyOf 2)	null	Alternative	No accounts found matching the lead data
$ (anyOf 1).__conversion_options.Contacts	JSON	Required within parent	Represents matching Contact records for the lead. Returns an array when matches exist, or null when no matching contacts are found.
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)	array	Alternative	Array of existing Contact records that match the lead data Maximum items: 100
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[]	object	Each item	Contact record with matching lead information Additional keys: not allowed
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].$approval_state	string	Required within parent	Current approval state of the contact record Known values: approved, pending, rejected, approval_process_pending, approval_process_rejected
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].$editable	boolean	Required within parent	Indicates if the contact record can be edited
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Account_Name	JSON	Optional	Represents the account associated with the matched contact. Returns account details when an association exists, or null when no account is linked.
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Account_Name (anyOf 1)	object	Alternative	Associated account information Additional keys: not allowed
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Account_Name (anyOf 1).Locked__s	boolean	Required within parent	Indicates if the account record is locked
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Account_Name (anyOf 1).id	string	Required within parent	Unique identifier of the account (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Account_Name (anyOf 1).name	string	Required within parent	Name of the account Maximum length: 200
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Account_Name (anyOf 2)	null	Alternative	No account associated with this contact
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Data_Processing_Basis	JSON	Required within parent	Represents the GDPR data processing basis for the matched contact. Returns a basis value when configured, or null when it is not specified.
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Data_Processing_Basis (anyOf 1)	string	Alternative	GDPR data processing basis for the contact Maximum length: 100
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Data_Processing_Basis (anyOf 2)	null	Alternative	No GDPR data processing basis specified
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Email	JSON	Required within parent	Represents the contact email value. Returns the email address when available, or null when the contact has no email value.
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Email (anyOf 1)	string	Alternative	Email address of the contact Format: email
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Email (anyOf 2)	null	Alternative	No email address provided
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Full_Name	string	Required within parent	Full name of the contact Maximum length: 200
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Layout	object	Optional	Layout information for the contact record Additional keys: not allowed
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Layout.id	string	Required within parent	Unique identifier of the layout (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Layout.name	string	Required within parent	Name of the layout Maximum length: 100
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].Locked__s	boolean	Required within parent	Indicates if the contact record is locked
$ (anyOf 1).__conversion_options.Contacts (anyOf 1)[].id	string	Required within parent	Unique identifier of the contact record (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.Contacts (anyOf 2)	null	Alternative	No contacts found matching the lead data
$ (anyOf 1).__conversion_options.module_preference	JSON	Required within parent	Represents the preferred module selected for lead conversion. Returns the module API name and ID when a preference exists, or null when no preference is set.
$ (anyOf 1).__conversion_options.module_preference (anyOf 1)	object	Alternative	Preferred module for conversion based on system configuration Additional keys: not allowed
$ (anyOf 1).__conversion_options.module_preference (anyOf 1).api_name	string	Required within parent	API name of the preferred module Maximum length: 100
$ (anyOf 1).__conversion_options.module_preference (anyOf 1).id	string	Required within parent	Unique identifier of the preferred module (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.module_preference (anyOf 2)	null	Alternative	No module preference set
$ (anyOf 1).__conversion_options.modules_with_multiple_layouts	JSON	Required within parent	Represents modules that provide multiple layout choices during conversion. Returns module details when available, or null when no module offers multiple layouts.
$ (anyOf 1).__conversion_options.modules_with_multiple_layouts (anyOf 1)	array	Alternative	Modules that have multiple layout options available Maximum items: 20
$ (anyOf 1).__conversion_options.modules_with_multiple_layouts (anyOf 1)[]	object	Each item	Module with multiple layouts Additional keys: not allowed
$ (anyOf 1).__conversion_options.modules_with_multiple_layouts (anyOf 1)[].api_name	string	Required within parent	API name of the module Maximum length: 100
$ (anyOf 1).__conversion_options.modules_with_multiple_layouts (anyOf 1)[].id	string	Required within parent	Unique identifier of the module (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.modules_with_multiple_layouts (anyOf 2)	null	Alternative	No modules have multiple layout options
$ (anyOf 1).__conversion_options.preference_field_matched_value	JSON	Required within parent	Represents field-level values from the lead that match existing Contact and Account fields. Returns mapped field details when matches exist, or null when no mappings are available.
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1)	object	Alternative	Field mappings showing how lead values match to Contact and Account fields Additional keys: not allowed
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts	JSON	Optional	Represents Account field mappings for matched lead values. Returns mapping entries when Account matches exist, or null when no Account mappings are available.
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)	array	Alternative	Account field mappings Maximum items: 50
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[]	object	Each item	Field mapping for account Additional keys: not allowed
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].field	object	Required within parent	Details of the field being mapped, including its API name, display label, uniqueness constraint, and ID. Additional keys: not allowed
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].field.api_name	string	Required within parent	API name of the field Maximum length: 100
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].field.field_label	string	Optional	Display label of the field Maximum length: 200
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].field.id	string	Required within parent	Unique identifier of the field (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].field.unique	JSON	Optional	Indicates whether the matched Account field has a uniqueness constraint. Returns true if the field is unique, false if it is not, or null if the uniqueness metadata is unavailable.
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].field.unique (anyOf 1)	boolean	Alternative	Indicates if the field has unique constraint
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].field.unique (anyOf 2)	null	Alternative	Field does not have unique constraint information
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 1)[].matched_lead_value	string	Required within parent	Value from the lead that matches this field Maximum length: 500
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Accounts (anyOf 2)	null	Alternative	No account field mappings available
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts	JSON	Optional	Represents Contact field mappings for matched lead values. Returns mapping entries when Contact matches exist, or null when no Contact mappings are available.
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)	array	Alternative	Contact field mappings Maximum items: 50
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[]	object	Each item	Field mapping for contact Additional keys: not allowed
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].field	object	Required within parent	Details of the field being mapped, including its API name, display label, uniqueness constraint, and ID. Additional keys: not allowed
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].field.api_name	string	Required within parent	API name of the field Maximum length: 100
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].field.field_label	string	Optional	Display label of the field Maximum length: 200
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].field.id	string	Required within parent	Unique identifier of the field (int64 as string) Maximum length: 50 Pattern: ^[0-9]+$
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].field.unique	JSON	Optional	Represents whether the matched Contact field has a uniqueness constraint. Returns a Boolean when uniqueness metadata is available, or null when it is not available.
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].field.unique (anyOf 1)	boolean	Alternative	Indicates if the field has unique constraint
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].field.unique (anyOf 2)	null	Alternative	Field does not have unique constraint information
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 1)[].matched_lead_value	string	Required within parent	Value from the lead that matches this field Maximum length: 500
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 1).Contacts (anyOf 2)	null	Alternative	No contact field mappings available
$ (anyOf 1).__conversion_options.preference_field_matched_value (anyOf 2)	null	Alternative	No field mappings available for conversion
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

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

No-content response statuses: [204]

Official provider source