> ## 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: README
> Convert a Lead. Zoho CRM Convert Convert Lead reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
Convert a Lead.
Tool ID: `zoho_crm_convert_convert_lead`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_convert_convert_lead',
{
"leadId": "lead_123",
"data": [
{
"overwrite": true,
"notify_lead_owner": true,
"notify_new_entity_owner": true
}
]
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_convert_convert_lead --input '{
"leadId": "lead_123",
"data": [
{
"overwrite": true,
"notify_lead_owner": true,
"notify_new_entity_owner": true
}
]
}' --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_convert_convert_lead --json` for the complete live contract.
## Input reference
Wrapper object containing array of conversion requests
| Name | Type | Required | Default | Details |
| ---------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.leadId` | `string` | Yes | — | Unique identifier of the Lead record to convert. Must be a valid Lead ID that exists in the CRM and has not been previously converted. Format: `int64`. |
| `payload.data` | `array` | Yes | — | Array of lead conversion configurations Maximum items: 100. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Wrapper object containing array of conversion requests",
"properties": {
"leadId": {
"type": "string",
"description": "Unique identifier of the Lead record to convert. Must be a valid Lead ID that exists in the CRM and has not been previously converted.",
"format": "int64"
},
"data": {
"type": "array",
"description": "Array of lead conversion configurations",
"maxItems": 100,
"items": {
"type": "object",
"description": "Configuration for converting a single lead",
"properties": {
"overwrite": {
"type": "boolean",
"description": "If true, overwrites existing Account or Contact data when add_to_existing_record is enabled. Default is false."
},
"notify_lead_owner": {
"type": "boolean",
"description": "If true, sends email notification to the Lead owner about the conversion. Default is false."
},
"notify_new_entity_owner": {
"type": "boolean",
"description": "If true, notifies the owner(s) of newly created Contact, Account, or Deal records. Default is false."
},
"add_to_existing_record": {
"type": "boolean",
"description": "When true, associates the Lead with an existing Account or Contact instead of creating duplicates."
},
"assign_to": {
"type": "object",
"description": "Specifies the user to assign the converted records to. If omitted, records are assigned to the current Lead owner.",
"properties": {
"id": {
"type": "string",
"description": "Zoho CRM user ID (int64 as string)",
"maxLength": 20
}
},
"required": [
"id"
],
"additionalProperties": false
},
"Deals": {
"type": "object",
"description": "Deal record configuration for lead conversion",
"properties": {
"Deal_Name": {
"type": "string",
"description": "Name of the Deal",
"maxLength": 120
},
"Campaign_Source": {
"type": "string",
"description": "Campaign source associated with this Deal",
"maxLength": 100
},
"Amount": {
"type": "number",
"description": "Expected revenue amount for the Deal",
"format": "double"
},
"Contact_Role": {
"type": "string",
"description": "Role of the Contact in this Deal",
"maxLength": 50
},
"Pipeline": {
"type": "string",
"description": "Sales pipeline for the Deal. Must match an existing pipeline in the CRM.",
"maxLength": 100
},
"$move_attachments": {
"type": "boolean",
"description": "If true, moves attachments from the Lead to the Deal"
},
"Stage": {
"type": "string",
"description": "Current stage of the Deal within the specified Pipeline. Must be valid for the chosen Pipeline.",
"maxLength": 100
},
"Closing_Date": {
"type": "string",
"description": "Expected closing date for the Deal (ISO 8601 date format: YYYY-MM-DD)",
"format": "date"
},
"Type": {
"type": "string",
"description": "Type of Deal (e.g., New Business, Existing Business)",
"maxLength": 50
},
"Probability": {
"type": "integer",
"description": "Win probability percentage (0-100)",
"minimum": 0,
"maximum": 100,
"format": "int32"
},
"Lead_Source": {
"type": "string",
"description": "Source from which the Lead originated",
"maxLength": 100
},
"Next_Step": {
"type": "string",
"description": "Next action or milestone for the Deal",
"maxLength": 200
},
"Description": {
"type": "string",
"description": "Detailed description of the Deal",
"maxLength": 32000
}
},
"required": [
"Deal_Name",
"Pipeline",
"Stage",
"Closing_Date"
],
"additionalProperties": false
},
"carry_over_tags": {
"type": "object",
"description": "Configuration for carrying over tags from the Lead to converted records",
"properties": {
"Contacts": {
"type": "object",
"description": "Tag carryover settings for Contact records",
"additionalProperties": true
},
"Accounts": {
"type": "object",
"description": "Tag carryover settings for Account records",
"additionalProperties": true
},
"Deals": {
"type": "object",
"description": "Tag carryover settings for Deal records",
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"required": [
"leadId",
"data"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ------------------------------------------ | ----------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Wrapper for successful conversion response |
| `result.data.data` | `array` | Yes | — | Array of conversion results Maximum items: 100. |
| `result.data.data[].code` | `"SUCCESS"` | Yes | — | Status code indicating successful conversion Allowed: `SUCCESS`. |
| `result.data.data[].message` | `string` | Yes | — | Human-readable message describing the conversion result Maximum length: 500. |
| `result.data.data[].status` | `"success"` | Yes | — | Overall status of the conversion operation Allowed: `success`. |
| `result.data.data[].details` | `object` | Yes | — | Details of created records including their IDs and names |
| `result.data.data[].details.Contacts` | `object` | Yes | — | Reference to a CRM entity with ID and name |
| `result.data.data[].details.Contacts.name` | `string` | Yes | — | Name of the entity Maximum length: 200. |
| `result.data.data[].details.Contacts.id` | `string` | Yes | — | Unique identifier of the entity record (int64 as string) Maximum length: 20. |
| `result.data.data[].details.Deals` | `record` | Yes | — | Deal record information, or null if no Deal was created |
| `result.data.data[].details.Accounts` | `record` | Yes | — | Account record information, or null if no Account was created |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Wrapper for successful conversion response",
"properties": {
"data": {
"type": "array",
"description": "Array of conversion results",
"maxItems": 100,
"items": {
"type": "object",
"description": "Successful lead conversion result",
"properties": {
"code": {
"type": "string",
"description": "Status code indicating successful conversion",
"enum": [
"SUCCESS"
]
},
"message": {
"type": "string",
"description": "Human-readable message describing the conversion result",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Overall status of the conversion operation",
"enum": [
"success"
]
},
"details": {
"type": "object",
"description": "Details of created records including their IDs and names",
"properties": {
"Contacts": {
"type": "object",
"description": "Reference to a CRM entity with ID and name",
"properties": {
"name": {
"type": "string",
"description": "Name of the entity",
"maxLength": 200
},
"id": {
"type": "string",
"description": "Unique identifier of the entity record (int64 as string)",
"maxLength": 20
}
},
"required": [
"name",
"id"
],
"additionalProperties": false
},
"Deals": {
"type": "object",
"description": "Deal record information, or null if no Deal was created",
"additionalProperties": true
},
"Accounts": {
"type": "object",
"description": "Account record information, or null if no Account was created",
"additionalProperties": true
}
},
"required": [
"Contacts",
"Deals",
"Accounts"
],
"additionalProperties": false
}
},
"required": [
"code",
"message",
"status",
"details"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## 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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)