Convert Lead

Purpose

To convert a lead into a contact or an account.

Endpoints

POST /Leads/{record_id}/actions/convert

Request Details

Request URL

https://www.zohoapis.com/crm/v2/Leads/{record_id}/actions/convert

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.leads.{operation_type}

Possible operation types

ALL - Full access to the record
WRITE - Edit records in the module
CREATE - Create records in the module

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2/Leads/1000000145990/actions/convert"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@convertlead.json"
-X POST

3.0.08.0

Copied//API Name of the module 
long leadId = 3477061000006603276 L;
//Get instance of RecordOperations Class
RecordOperations recordOperations = new RecordOperations();

//Get instance of ConvertBodyWrapper Class that will contain the request body
ConvertBodyWrapper request = new ConvertBodyWrapper();

//List of LeadConverter instances
List < LeadConverter > data = new ArrayList < LeadConverter > ();

//Get instance of LeadConverter Class
LeadConverter record1 = new LeadConverter();

record1.setOverwrite(true);

record1.setNotifyLeadOwner(true);

record1.setNotifyNewEntityOwner(true);

record1.setAccounts("3477061000005848125");

record1.setContacts("3477061000000358009");

record1.setAssignTo("3477061000000173021");

com.zoho.crm.api.record.Record deals = new com.zoho.crm.api.record.Record();

/*
 * Call addFieldValue method that takes two arguments
 * 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
 * 2 -> Value
 */
deals.addFieldValue(Field.Deals.DEAL_NAME, "deal_name");

deals.addFieldValue(Field.Deals.DESCRIPTION, "deals description");

deals.addFieldValue(Field.Deals.CLOSING_DATE, LocalDate.of(2021, 1, 13));

deals.addFieldValue(Field.Deals.STAGE, new Choice < String > ("Closed Won"));

deals.addFieldValue(Field.Deals.AMOUNT, 50.7);

/*
 * Call addKeyValue method that takes two arguments
 * 1 -> A string that is the Field's API Name
 * 2 -> Value
 */
deals.addKeyValue("Custom_field", "Value");

deals.addKeyValue("Custom_field_2", "value");

List < Tag > tagList = new ArrayList < Tag > ();

Tag tag = new Tag();

tag.setName("TestDeals");

tagList.add(tag);

deals.setTag(tagList);

record1.setDeals(deals);

//Add Record instance to the list
data.add(record1);

//Set the list to Records in BodyWrapper instance
request.setData(data);

//Call convertLead method that takes leadId and ConvertBodyWrapper instance as parameter.
APIResponse < ConvertActionHandler > response = recordOperations.convertLead(leadId, request);

Copiedimport javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONObject;
public class ConvertLead 
{
	@SuppressWarnings("deprecation")
	public static void main(String[] args) 
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2/Leads/34770617753002/actions/convert");
			HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
			HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
			JSONObject requestBody = new JSONObject();
			JSONArray recordArray = new JSONArray();
			JSONObject recordObject = new JSONObject();
			recordObject.put("overwrite", true);
			recordObject.put("notify_lead_owner", true);
			recordObject.put("notify_new_entity_owner", true);
			recordObject.put("Accounts", "34770617673023");
			recordObject.put("Contacts", "34770617635005");
			recordObject.put("assign_to", "34770610173021");
			JSONObject deals = new JSONObject();
			deals.put("Campaign_Source", "34770617229030");
			deals.put("Deal_Name", "Robert");
			deals.put("Closing_Date", "2016-03-30");
			deals.put("Stage", "Closed Won");
			deals.put("Amount", 56.6);
			recordObject.put("Deals", deals);
			recordArray.put(recordObject);
			requestBody.put("data", recordArray);
			requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
}

3.0.07.x

Copied//Get instance of RecordOperations Class
$recordOperations = new RecordOperations();
//Get instance of ConvertBodyWrapper Class that will contain the request body
$request = new ConvertBodyWrapper();
//List of LeadConverter instances
$data = array();
//Get instance of LeadConverter Class
$record1 = new LeadConverter();
$record1->setOverwrite(true);
$record1->setNotifyLeadOwner(true);
$record1->setNotifyNewEntityOwner(true);
$record1->setAccounts("3477061005848125");
$record1->setContacts("347706100358009");
$record1->setAssignTo("347706100173021");
$recordClass = 'com\zoho\crm\api\record\Record';
$deals = new $recordClass();
/*
 * Call addFieldValue method that takes two arguments
 * 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
 * 2 -> Value
 */
$field = new Field("");
 /*
 * Call addKeyValue method that takes two arguments
 * 1 -> A string that is the Field's API Name
 * 2 -> Value
 */
$deals->addKeyValue("Custom_field", "Value");
$deals->addKeyValue("Custom_field_2", "value");
$tagList = array();
$tag = new Tag();
$tag->setName("TestDeals");
array_push($tagList, $tag);
$deals->setTag($tagList);
// $record1->setDeals($deals);
//Add Record instance to the list
array_push($data, $record1);
//Set the list to Records in BodyWrapper instance
$request->setData($data);
//Call updateRecord method that takes BodyWrapper instance, ModuleAPIName and recordId as parameter.
$response = $recordOperations->convertLead($recordId,$request );

Copied<?php

class ConvertLead
{
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2/Leads/352403305811001/actions/convert";
        
        $curl_options[CURLOPT_URL] =$url;
        $curl_options[CURLOPT_RETURNTRANSFER] = true;
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "POST";
        $requestBody = array();
        $recordArray = array();
        $recordObject = array();
        $recordObject["overwrite"]=true;
        $recordObject["notify_lead_owner"]=true;
        $recordObject["Accounts"]="3524033000005113002";
        $recordObject["notify_new_entity_owner"]=true;
        $recordObject["Contacts"]="3524033000003661075";
        
        $recordArray[] = $recordObject;
        $requestBody["data"] =$recordArray;
        $curl_options[CURLOPT_POSTFIELDS]= json_encode($requestBody);
        $headersArray = array();
        
        $headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
        
        $curl_options[CURLOPT_HTTPHEADER]=$headersArray;
        
        curl_setopt_array($curl_pointer, $curl_options);
        
        $result = curl_exec($curl_pointer);
        $responseInfo = curl_getinfo($curl_pointer);
        curl_close($curl_pointer);
        list ($headers, $content) = explode("\r\n\r\n", $result, 2);
        if(strpos($headers," 100 Continue")!==false){
            list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
        }
        $headerArray = (explode("\r\n", $headers, 50));
        $headerMap = array();
        foreach ($headerArray as $key) {
            if (strpos($key, ":") != false) {
                $firstHalf = substr($key, 0, strpos($key, ":"));
                $secondHalf = substr($key, strpos($key, ":") + 1);
                $headerMap[$firstHalf] = trim($secondHalf);
            }
        }
        $jsonResponse = json_decode($content, true);
        if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
            list ($headers, $content) = explode("\r\n\r\n", $content, 2);
            $jsonResponse = json_decode($content, true);
        }
        var_dump($headerMap);
        var_dump($jsonResponse);
        var_dump($responseInfo['http_code']);
        
    }
    
}
(new ConvertLead())->execute();

3.0.08.x

Copied//Get instance of RecordOperations Class
RecordOperations recordOperations = new RecordOperations();
//Get instance of ConvertBodyWrapper Class that will contain the request body
ConvertBodyWrapper request = new ConvertBodyWrapper();
//List of LeadConverter instances
List<LeadConverter> data = new List<LeadConverter>();
//Get instance of LeadConverter Class
LeadConverter record1 = new LeadConverter();
//Add Record instance to the list
data.Add(record1);
//Set the list to Records in BodyWrapper instance
request.Data = data;
//Call ConvertLead method that takes leadId and ConvertBodyWrapper instance as parameter.
APIResponse<ConvertActionHandler> response = recordOperations.ConvertLead(leadId, request);

Copiedusing System;
using System.IO;
using System.Net;
using System.Text;
using Newtonsoft.Json.Linq;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Records
{
    public class ConvertLead
    {
        public static void ConvertLeadRecord()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/Leads/34770617856002/actions/convert");
            request.Method = "POST";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("overwrite", true);
            recordObject.Add("notify_lead_owner", true);
            recordObject.Add("notify_new_entity_owner", true);
            recordObject.Add("Accounts", "34770617673023");
            recordObject.Add("Contacts", "34770617635005");
            recordObject.Add("assign_to", "347706173021");
            JObject deals = new JObject();
            deals.Add("Campaign_Source", "3477007229030");
            deals.Add("Deal_Name", "Robert");
            deals.Add("Closing_Date", "2016-03-30");
            deals.Add("Stage", "Closed Won");
            deals.Add("Amount", 56.6);
            recordObject.Add("Deals", deals);
            recordArray.Add(recordObject);
            requestBody.Add("data", recordArray);
            string dataString = requestBody.ToString();
            var data = Encoding.UTF8.GetBytes(dataString);
            int dataLength = data.Length;
            request.ContentLength = dataLength;
            using (var writer = request.GetRequestStream())
            {
                writer.Write(data, 0, dataLength);
            }
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
        public static void AddNotesforASpecificRecord()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/Leads/347707736020/Notes");
            request.Method = "POST";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("Note_Title", "Contacted");
            recordObject.Add("Note_Content", "Need to do further tracking");
            recordArray.Add(recordObject);
            recordObject = new JObject();
            recordObject.Add("Note_Title", "Contacted1");
            recordObject.Add("Note_Content", "Need to do further tracking");
            recordArray.Add(recordObject);
            requestBody.Add("data", recordArray);
            string dataString = requestBody.ToString();
            var data = Encoding.UTF8.GetBytes(dataString);
            int dataLength = data.Length;
            request.ContentLength = dataLength;
            using (var writer = request.GetRequestStream())
            {
                writer.Write(data, 0, dataLength);
            }
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
    }
}

3.0.03.x.x

Copied# Get instance of RecordOperations Class
record_operations = RecordOperations()
# Get instance of ConvertBodyWrapper Class that will contain the request body
request = ConvertBodyWrapper()
# List to hold LeadConverter instances
data = []
# Get instance of LeadConverter Class
record = LeadConverter()
record.set_overwrite(True)
record.set_notify_lead_owner(True)
record.set_notify_new_entity_owner(True)
record.set_accounts('3409643000000692007')
record.set_contacts('3409643000000836001')
record.set_assign_to('3409643000000302031')
deals = ZCRMRecord()
"""
Call add_field_value method that takes two arguments
Import the zcrmsdk.src.com.zoho.crm.api.record.field file
1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the
displayed list.
2 -> Value
"""
deals.add_field_value(Field.Deals.deal_name(), 'deal_name')
deals.add_field_value(Field.Deals.description(), "deals description")
deals.add_field_value(Field.Deals.closing_date(), date(2020, 10, 2))
deals.add_field_value(Field.Deals.stage(), Choice("Closed Won"))
deals.add_field_value(Field.Deals.amount(), 500.78)
"""
Call add_key_value method that takes two arguments
1 -> A string that is the Field's API Name
2 -> Value
"""
deals.add_key_value('Custom_field', 'Value')
tag_list = []
tag = Tag()
tag.set_name('Converted')
tag_list.append(tag)
deals.set_tag(tag_list)
record.set_deals(deals)
data.append(record)
request.set_data(data)
# Call convertLead method that takes ConvertBodyWrapper instance and lead_id as parameter
response = record_operations.convert_lead(lead_id, request)

Copieddef convert_lead():
    import requests
    import json

    url = 'https://www.zohoapis.com/crm/v2/Leads/3409643000002730081/actions/convert'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    request_body = dict()
    record_list = list()
    record_object = dict()
    record_object['overwrite'] = True
    record_object['notify_lead_owner'] = True
    record_object['notify_new_entity_owner'] = True
    record_object['Accounts'] = '3409643000002730101'
    record_object['Contacts'] = '3409643000002730097'
    deals = {
        'Deal_Name': 'New Deal',
        'Closing_Date': '2020-12-10',
        'Amount': '500.50',
        'Stage': 'Closed Won'
    }
    record_object['Deals'] = deals

    record_list.append(record_object)

    request_body['data'] = record_list

    response = requests.post(url=url, headers=headers, data=json.dumps(request_body).encode('utf-8'))

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

convert_lead()

1.0.010.x

Copied//Get instance of RecordOperations Class
let recordOperations = new RecordOperations();
//Get instance of ConvertBodyWrapper Class that will contain the request body
let request = new ConvertBodyWrapper();
//Array to hold LeadConverter instances
let data = [];
//Get instance of LeadConverter Class
let record = new LeadConverter();
record.setOverwrite(true);
record.setNotifyLeadOwner(true);
record.setNotifyNewEntityOwner(true);
record.setAccounts("3409643000000692007");
record.setContacts("3409643000000836001");
record.setAssignTo("3409643000000302031");
let deals = new Record();
/*
 * Call addFieldValue method that takes two arguments
 * Import the "zcrmsdk/core/com/zoho/crm/api/record/field" file
 * 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
 * 2 -> Value
 */
deals.addFieldValue(Field.Deals.DEAL_NAME, "deal_name");
deals.addFieldValue(Field.Deals.DESCRIPTION, "deals description");
deals.addFieldValue(Field.Deals.CLOSING_DATE, new Date(2021, 2, 13));
deals.addFieldValue(Field.Deals.STAGE, new Choice("Closed Won"));
deals.addFieldValue(Field.Deals.AMOUNT, 50.7);
/*
 * Call addKeyValue method that takes two arguments
 * 1 -> A string that is the Field's API Name
 * 2 -> Value
 */
deals.addKeyValue("Custom_field", "Value");
deals.addKeyValue("Custom_field_2", "value");
let tagArray = [];
let tag = new Tag();
tag.setName("Converted");
tagArray.push(tag);
deals.setTag(tagArray);
//Set the Deal record to deals in LeadConverter instance
record.setDeals(deals);
//Add the instance to array
data.push(record);
//Set the array to data ConvertBodyWrapper instance
request.setData(data);
//Call convertLead method that takes ConvertBodyWrapper instance and leadId as parameter
let response = await recordOperations.convertLead(leadId, request);

Copiedasync function convertLead() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2/Leads/3409643000002730081/actions/convert'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.354df3680XXXXXXXXXXXXX3.aae0efXXXXXXXXXXXXXXXXXX9"
    }

    let requestBody = {}
    let recordArray = []
    let recordObject = {}

    recordObject['overwrite'] = true
    recordObject['notify_lead_owner'] = true
    recordObject['notify_new_entity_owner'] = true
    recordObject['Accounts'] = '3409643000002730101'
    recordObject['Contacts'] = '3409643000002730097'

    let deals = {
        'Deal_Name': 'New Deal',
        'Closing_Date': '2020-12-10',
        'Amount': '500.50',
        'Stage': 'Closed Won'
    }
    recordObject['Deals'] = deals

    recordArray.push(recordObject)

    requestBody['data'] = recordArray

    let requestDetails = {
        method : "POST",
        headers : headers,
        body : JSON.stringify(requestBody),
        encoding: "utf8",
        throwHttpErrors : false
    };
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    } 
}
convertLead()

2.02.x.x

Copied# """
records = []
module_api_name = 'Leads'
(0..0).each do |i|
  # Get instance of LeadConverter Class
  record = Record::LeadConverter.new
  #set overwrite
  record.overwrite = true
  #set notify lead owner
  record.notify_lead_owner = true
  #set notify entity lead owner
  record.notify_new_entity_owner = true
  #set accounts
  record.accounts = '3524033000005113002'
  #set contacts
  record.contacts = '3524033000003429023'
  #set assign to
  record.assign_to = '3524033000003523022'
  Date.new(2001, 2, 3)
  #get instance of deals record
  deals = Record::Record.new
  # """
  # Call add_field_value method that takes two arguments
  # 1 -> Call Field "::" and choose the module from the displayed list and press "." and choose the field name from the displayed list.
  # 2 -> Value
  # """
  deals.add_field_value(Record::Field::Deals.Closing_date, DateTime.new(2019, 8, 10, 4, 10, 9))
  deals.add_field_value(Record::Field::Deals.Deal_name, 'deal_name')
  deals.add_field_value(Record::Field::Deals.Description, 'deal_name')
  deals.add_field_value(Record::Field::Deals.Stage, Util::Choice.new('Closed Won'))
  deals.add_field_value(Record::Field::Deals.Amount, 50.7)
  # """
  # Call add_key_value method that takes two arguments
  # 1 -> A string that is the Field's API Name
  # 2 -> Value
  # """

  deals.add_key_value('Custom_field', 'Value')
  deals.add_key_value('Custom_field_2', 'value')
  # deals.add_key_value("Closing_Date","2020-08-11T14:21:15+05:30")
  record.deals = deals
  records.push(record)
end
# Get instance of ConvertBodyWrapper Class that will contain the request body
convert_body_wrapper = Record::ConvertBodyWrapper.new
#set records to data
convert_body_wrapper.data = records
# Get instance of RecordOperations Class
rr = Record::RecordOperations.new
# Call convertLead method that takes ConvertBodyWrapper instance and lead_id as parameter
response = rr.convert_lead(lead_id,convert_body_wrapper)

Copiedclass ConvertLead
    def execute
       
        url ="https://www.zohoapis.com/crm/v2/Leads/3524005811001/actions/convert"
        url = URI(url)
        req = Net::HTTP::Post.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.50XXXXXXXXX&77e3a.44XXXXXXXXX8353"
        headers&.each { |key, value| req.add_field(key, value) }
       
        request_body = {};
        record_array = [];
        record_object = {};
        record_object["overwrite"]=true;
        record_object["notify_lead_owner"]=true;
        record_object["Accounts"]="3524033002";
        record_object["notify_new_entity_owner"]=true;
        record_object["Contacts"]="3524033061075";  
        record_array = [record_object];
        request_body["data"] =record_array; 
        request_json = request_body.to_json
        req.body = request_json.to_s
        response=http.request(req)
        status_code = response.code.to_i
        headers = response.each_header.to_h
        print status_code
        print headers
        unless response.body.nil?
            print  response.body
        end
    end
end

ConvertLead.new.execute

1.0.0ES6

Copied//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ConvertBodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.ConvertBodyWrapper();
//Array to hold LeadConverter instances
let data = [];
//Get instance of LeadConverter Class
let record = new ZCRM.Record.Model.LeadConverter();
record.setOverwrite(true);
record.setNotifyLeadOwner(true);
record.setNotifyNewEntityOwner(true);
record.setAccounts("3409643692007");
record.setContacts("3409643836001");
record.setAssignTo("3409643302031");
let deals = new ZCRM.Record.Model.Record();
/*
 * Call addFieldValue method that takes two arguments
 * Import the "zcrmsdk/core/com/zoho/crm/api/record/field" file
 * 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
 * 2 -> Value
 */
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.DEAL_NAME, "deal_name");
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.DESCRIPTION, "deals description");
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.CLOSING_DATE, new Date(2021, 2, 13));
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.STAGE, new Choice("Closed Won"));
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.AMOUNT, 50.7);
/*
 * Call addKeyValue method that takes two arguments
 * 1 -> A string that is the Field's API Name
 * 2 -> Value
 */
deals.addKeyValue("Custom_field", "Value");
deals.addKeyValue("Custom_field_2", "value");
let tagArray = [];
let tag = new ZCRM.Tag.Model.Tag();
tag.setName("Converted");
tagArray.push(tag);
deals.setTag(tagArray);
//Set the Deal record to deals in LeadConverter instance
record.setDeals(deals);
//Add the instance to array
data.push(record);
//Set the array to data ConvertBodyWrapper instance
request.setData(data);
//Call convertLead method that takes ConvertBodyWrapper instance and leadId as parameter
let response = await recordOperations.convertLead(leadId, request);

Copiedvar listener = 0;
class ConvertLead {

	async convertLeadRecord()	{
		var url = "https://www.zohoapis.com/crm/v2/Leads/34770618863059/actions/convert"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.CXASM1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5501/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new ConvertLead().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        var requestMethod = "POST"
        var reqBody = {"data":[{"overwrite":true,"notify_new_entity_owner":true,"notify_lead_owner":true,"Note_Content":"asd","$se_module":"Leads","Contacts":"34770619080160","Deals":{"Campaign_Source":"34770617229030","Deal_Name":"Robert","Closing_Date":"2016-03-30","Stage":"Closed Won","Amount":65.6},"Accounts":"34770619080156","assign_to": "3477061173021"}]}
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new ConvertLead().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
	}

    async getToken(token) {

        if(listener == 0) {

            window.addEventListener("storage", function(reponse) {
                if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
                    location.reload();
                }
                if(reponse.key === "access_token"){

                    sessionStorage.removeItem("__auth_process");
                }
            }, false);
            listener = 1;
            if(sessionStorage.getItem("__auth_process")) {
                sessionStorage.removeItem("__auth_process");
            }
        }
        ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
            var isKeyExists = localStorage.hasOwnProperty(k);
            if(isKeyExists) {
                sessionStorage.setItem(k, localStorage[k]);
            }
            localStorage.removeItem(k);
        });
        var valueInStore = sessionStorage.getItem("access_token");
        var tokenInit = sessionStorage.getItem("__token_init");
        if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
            valueInStore = null;
            sessionStorage.removeItem("access_token");
        }

        var auth_process = sessionStorage.getItem("__auth_process");
        if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
            var accountsUrl = "https://accounts.zoho.com/oauth/v2/auth"
            var clientId;
            var scope;
            var redirectUrl;
            if(token != null) {
                clientId = token.clientId;
                scope = token.scope;
                redirectUrl = token.redirectUrl;
            }

            var fullGrant = sessionStorage.getItem("full_grant");
            var grantedForSession = sessionStorage.getItem("granted_for_session");
            if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
                accountsUrl += '/refresh';
            }
            if (clientId && scope) {
                sessionStorage.setItem("__token_init", Date.now());
                sessionStorage.removeItem("access_token");
                sessionStorage.setItem("__auth_process", "true");
                window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
                ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
                    var isKeyExists = localStorage.hasOwnProperty(k);
                    if(isKeyExists){
                        sessionStorage.setItem(k, localStorage[k]);
                    }
                    localStorage.removeItem(k);
                });
                valueInStore = sessionStorage.getItem("access_token");
            }
        }
        if(token != null && valueInStore != 'undefined'){
            token.accessToken = valueInStore;
        }
        return token.accessToken;
    }

    async makeAPICall(requestDetails) {
        return new Promise(function (resolve, reject) {
            var body, xhr, i;
            body = requestDetails.body || null;
            xhr = new XMLHttpRequest();
            xhr.withCredentials = true;
            xhr.open(requestDetails.method, requestDetails.uri, true);
            for (i in requestDetails.headers) {
                xhr.setRequestHeader(i, requestDetails.headers[i]);
            }
            xhr.send(body);
            xhr.onreadystatechange = function() {
                if(xhr.readyState == 4) {
                    resolve(xhr);
                }
            }
        })
    }
}

CopiedSyntax:
zoho.crm.convertLead(<leadId Long>,<dataMap Map>,<connectionName String>,<userAccess Boolean>);
mandatory : leadId,dataMap

Sample Request:
resp = zoho.crm.convertLead("7000000037308", { "overwrite": true, "notify_lead_owner": false, "notify_new_entity_owner": true, "Accounts": "7000000037323", "Deals": { "Deal_Name": "Robert", "Closing_Date": "2016-03-30", "Stage": "Closed Won", "Amount": 56.6 } });

Show full

Show less

In the request, "@convertlead.json" contains the sample input.

Input JSON Keys

To convert leads, send a POST request with request body containing the following attributes:

overwriteboolean, optional
Specify if the Lead details must be overwritten in the Contact/Account/Deal based on lead conversion mapping configuration.
true: Overwrite the lead details in Contact/Account/Deal. Note that when this value is true and you have specified an account ID, only the account name will be overwritten with the company name of that contact. Rest of the details are unchanged.
false: Do not overwrite the lead details to Contact/Account/Deal.
notify_lead_ownerboolean, optional
Specify whether the lead owner must get notified about the lead conversion via email.
true: The lead owner gets notified about the conversion via email.
false: The lead owner does not get notified about the conversion via email. The default value is false.
notify_new_entity_ownerboolean, optional
Specify whether the user to whom the contact/account is assigned to must get notified about the lead conversion via email.
true: The user gets notified about the conversion via email.
false: The user does not get notified about the conversion via email. The default value is false.
Accountsstring, optional
Use this key to associate an account with the lead being converted. Pass the unique and valid account ID.
Example: "Accounts": "4000000373187"
Contactsstring, optional
Use this key to associate a contact with the lead being converted. Pass the unique and valid contact ID.
Example: "Contacts": "4000000372131"
Contact_RoleString, optional
Use this key to assign a role to the contact that you have associated on conversion. Make a GET Contact Roles API call and pass the unique contact role ID.
assign_tostring, optional
Use this key to assign record owner for the new contact and account. Pass the unique and valid user ID.
Example: "assign_to": "4000000219019"
DealsJSON object, optional
Use this key to create a deal for the newly created Account. The "Deal_Name", "Closing_Date", and "Stage" are default mandatory keys to be passed in the JSON object.
carry_over_tagsJSON object, optional
Use this key to carry over tags of the lead to contact, account, and deal. Refer to sample input for format.

Note

In the input, the assign_to value can only be the User ID.
You can associate the existing contact or account to the converting lead even if the lead is converted or not converted to a deal. To achieve this, you have to send the account ID and contact ID in your input data.
If both account ID and overwrite values are true, then the account name will be replaced by the company name, while associating it with the existing account. However, the data of that account will remain the same.
If overwrite value is set to false, then association will only happen. However, if you set the overwrite value without account ID, the working of this method remains unchanged.
If contact ID is given in your input, then the converting lead will be associated to the existing contact.
You must use only Field API names in the input. You can obtain the field API names from
- Fields metadata API (the value for the key “api_name” for every field). (Or)
- Setup > Developer Hub > APIs and SDKs > API Names > {{Module}}. Choose “Fields” from the “Filter By” drop-down.

Sample Input

Copied{
    "data": [
        {
            "overwrite": true,
            "notify_lead_owner": true,
            "notify_new_entity_owner": true,
            "Accounts": "4150868000003283003",
            "Contacts": "4150868000003283024",
            "assign_to": "4150868000001248015",
            "Deals": {
                "Deal_Name": "Robert",
                "Closing_Date": "2020-07-24",
                "Stage": "Closed Won",
                "Amount": 56.6,
                "Pipeline": "Standard (Standard)",
                "Contact_Role": "5545974000000006873"
            },
            "carry_over_tags": {
                "Contacts": [
                    "tag1",
                    "tag2"
                ],
                "Accounts": [
                    "tag1"
                ],
                "Deals": [
                    "tag1"
                ]
            }
        }
    ]
}

Possible Errors

DUPLICATE_DATAHTTP 400
Duplicate data
Resolution: There already exists a contact with the unique field details present in lead. Ensure you specify unique values for unique fields (both system and user-defined). To know which fields are unique, refer to Fields Metadata API.
ID_ALREADY_CONVERTEDHTTP 400
id already converted
Resolution: The lead you are trying to convert has already been converted. Specify a valid lead ID. Refer to Get Records API to get valid lead IDs.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.{module_name}.CREATE. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to create
Resolution: The user does not have permission to create records. Contact your system administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to create records
Resolution: The user does not have the permission to create records. Contact your system administrator.
INVALID_DATAHTTP 400
invalid data
Resolution: The input specified is incorrect. Specify valid input.
RECORD_LOCKEDHTTP 400
cannot convert record that is not approved yet
Resolution: Please wait until the Zia image or the merge duplicates process is complete and try again.
NOT_APPROVEDHTTP 400
cannot convert record that is not approved yet
Resolution:
- Case 1: If the record is in the rejected state due to Zia image validation, either upload a new image (or) delete the failed image and, resubmit the record to Zia image validation.
- Case 2: If the record is in Zia record approval, the system will not allow you to update the images of the record until the reviewer approves or rejects the record.

Sample Response

Copied{
    "data": [
       {
            "Contacts": "4000000372131",
            "Deals": "4000000377192",
            "Accounts": "4000000373187"
        }
    ]
}

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor

Workplace

Vani

Expense

Recruit

People