Zoho CRM Connector

ZappySys Zoho CRM Connector provide read / write capability inside your app (see list below), using these drag and drop , high performance connector you can perform many Zoho CRM operations without any coding. You can use this connector to integrate Zoho CRM data inside apps like SSIS, SQL Server or popular ETL Platforms / BI Tools/ Reporting Apps / Programming languages (i.e. Informatica, Power BI, SSRS, Excel, C#, JAVA, Python)

Download for SSIS Download for Other Apps Documentation

Click on your App below to get started with Zoho CRM Integration

Choose your App / Scenario for which you like to integrate Zoho CRM

Actions supported by Zoho CRM Connector

Zoho CRM Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Read Data (Query Mode - Max 200 Rows Only)
   [Read more...]
Parameter Description
sql_query Your SQL query for CRM (i.e. COQL (CRM Object Query Language)). Limtation - You can fetch maximum 200 rows using COQL Query. To read all rows use Table mode. (refer to help link to learn more about COQL)
 List Modules
   [Read more...]
Parameter Description
 List Territories
   [Read more...]
 List Module Settings
To get the metadata for a specific module. Specify the API name of the module, such as Leads, Accounts or Deals in your API request.    [Read more...]
Parameter Description
module Module name for which you like to get settings
Option Value
Accounts Accounts
Activities Activities
Calls Calls
Campaigns Campaigns
Cases Cases
Contacts Contacts
Deals Deals
Events Events
Invoices Invoices
Leads Leads
Price_Books Price_Books
Products Products
Purchase_Orders Purchase_Orders
Quotes Quotes
Sales_Orders Sales_Orders
Solutions Solutions
Tasks Tasks
Vendors Vendors
Your_Custom_Module_Name Your_Custom_Module_Name
 List Tags
List tags for module.    [Read more...]
Parameter Description
module Module name for which you like to get settings
Option Value
Accounts Accounts
Activities Activities
Calls Calls
Campaigns Campaigns
Cases Cases
Contacts Contacts
Deals Deals
Events Events
Invoices Invoices
Leads Leads
Price_Books Price_Books
Products Products
Purchase_Orders Purchase_Orders
Quotes Quotes
Sales_Orders Sales_Orders
Solutions Solutions
Tasks Tasks
Vendors Vendors
Your_Custom_Module_Name Your_Custom_Module_Name
 Gets record count for specific tag for module
Add tags for specified module and specified record id(s).    [Read more...]
Parameter Description
module Module name for which you like to get settings
Option Value
Accounts Accounts
Activities Activities
Calls Calls
Campaigns Campaigns
Cases Cases
Contacts Contacts
Deals Deals
Events Events
Invoices Invoices
Leads Leads
Price_Books Price_Books
Products Products
Purchase_Orders Purchase_Orders
Quotes Quotes
Sales_Orders Sales_Orders
Solutions Solutions
Tasks Tasks
Vendors Vendors
Your_Custom_Module_Name Your_Custom_Module_Name
Tag Id Use List Tags to findout Id for tag you like to query
 Add / Update Tags for records
Add tags for specified module and specified record id(s).    [Read more...]
Parameter Description
module Module name for which you like to get settings
Option Value
Accounts Accounts
Activities Activities
Calls Calls
Campaigns Campaigns
Cases Cases
Contacts Contacts
Deals Deals
Events Events
Invoices Invoices
Leads Leads
Price_Books Price_Books
Products Products
Purchase_Orders Purchase_Orders
Quotes Quotes
Sales_Orders Sales_Orders
Solutions Solutions
Tasks Tasks
Vendors Vendors
Your_Custom_Module_Name Your_Custom_Module_Name
Record Id(s) (comma seperated list) List of Record Id(s) you like to update
Tag Id List of Tag(s) you like to add
Overwrite Set this to overwrite exising tags for the record(s)
Option Value
true true
false false
 List Module Fields
To get the field meta data for the specified module. The fields displayed are from all layouts for the module and the response does not contain layout-specific fields like mandatory fields or picklist values.    [Read more...]
Parameter Description
module Module name for which you like to get all fields
Option Value
Accounts Accounts
Activities Activities
Calls Calls
Campaigns Campaigns
Cases Cases
Contacts Contacts
Deals Deals
Events Events
Invoices Invoices
Leads Leads
Price_Books Price_Books
Products Products
Purchase_Orders Purchase_Orders
Quotes Quotes
Sales_Orders Sales_Orders
Solutions Solutions
Tasks Tasks
Vendors Vendors
Your_Custom_Module_Name Your_Custom_Module_Name
 List Views
   [Read more...]
Parameter Description
module Module name for which you like to get all views
 Read [$parent.module_name$]
This endpoint reads records using bulk approach. Default API Version is V2 (set connection level) and its almost 2 times faster than higher API version (e.g. V3+) but V2 may return less number of columns compared to new API versions (e.g. v3...v7+). API V2 makes less number of requests and returns more records per call (200 rows), on the other side V3+ has limits of max 50 fields in each Get Records API calls. To avoid this limitation in V3+ API we used /{module}?ids={150 ids} workaround but this is still slower compred to older API (v2) approach. Choose new API if you have a valid reason (e.g. you need additional new columns exposed in v3+) else stick with older version V2 (its default setting)    [Read more...]
Parameter Description
Module
Last Modified Date - Read data modified after it Supply this DateTime (ISO 8601 format) - To get the list of recently modified records
Custom View ID To get the list of records based on custom views.
Fields (Only for V2 API) To retrieve specific field values. Kepp blank to get all fields.
sort_by Specify the field name based on which the records must be sorted.
sort_order To sort the list of records in either ascending or descending order.
Option Value
asc asc
desc desc
territory_id To get the list of records in a territory. Use get_territories endpoint to list Id and names.
include_child To include records from the child territories. Default is false.
Option Value
true true
false false
converted converted
Option Value
true true
false false
both both
 Read [$parent.module_name$] (Use this for fewer than 50 Fields in v3+)
Use this endpoint if you have fewer than 50 fields and you like to utilize newer APi e.g. V3+, If you calling older API V2 then you can use any endpoint (e.g. get_contacts or get_contacts_fast or Contacts table all yeilds same speed in V2).    [Read more...]
Parameter Description
Module
Last Modified Date - Read data modified after it Supply this DateTime (ISO 8601 format) - To get the list of recently modified records
Custom View ID To get the list of records based on custom views.
Fields (Only for V2 API) To retrieve specific field values. Kepp blank to get all fields.
sort_by Specify the field name based on which the records must be sorted.
sort_order To sort the list of records in either ascending or descending order.
Option Value
asc asc
desc desc
territory_id To get the list of records in a territory. Use get_territories endpoint to list Id and names.
include_child To include records from the child territories. Default is false.
Option Value
true true
false false
converted converted
Option Value
true true
false false
both both
 Search [$parent.module_name$]
Search records by criteria or email or phone or word or id (specify only one parameter for search and keep other blank)    [Read more...]
Parameter Description
Search By Criteria Expression You can supply upto 10 criterias. For more complex expression use Query API. Example: ((Last_Name:equals:Burns)and(First_Name:starts_with:Ma)). You can lookup row by ID like (id:equals:1458554000067017001). Here is Syntax for expression (({api_name}:{starts_with|equals|in|between|not_equal|greater_equal|less_equal}:{value})and/or({api_name}:{starts_with|equals|in|between|not_equal|greater_equal|less_equal}:{value}))
Option Value
None
Example of Equal (id:equal:11223344)
Example NOT EQUAL (id:not_equal:11223344)
Example OR (multiple conditions) (id:equal:1111111)or(id:equal:222222222)
Example IN (id:in:1111111,222222222,333333333)
Example START_WITH (Last_Name:starts_with:pat)
Example BETWEEN (Created_Time:between:2024-02-01T18:52:56+00:00,2024-02-20T18:52:56+00:00)
Search By Email
Search By Phone
Search By any Word
Search By Id
Include only converted records
Option Value
true true
false false
both both
Include approved records
Option Value
true true
false false
both both
 Delete [$parent.module_name$]
   [Read more...]
Parameter Description
Record ID(s) - Use Comma for multiple (e.g. 111,222)
Fire Wordflow Trigger
Option Value
true true
false false
 Insert [$parent.module_name$]
   [Read more...]
Parameter Description
Triggers
 Update [$parent.module_name$]
   [Read more...]
Parameter Description
Triggers
 Upsert [$parent.module_name$] (Update or Insert)
   [Read more...]
Parameter Description
Triggers
Duplicate_Check_Fields
Option Value
By Email Email
By Phone Phone
By Mobile Mobile
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Zoho CRM Connector Examples (For ODBC PowerPack)

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Read all rows    [Read more...]

SELECT * from Accounts

Update Owner of the record(s) - Account, Contacts, Deals, Leads (Update Lookup field)    [Read more...]

This examples shows how to update a lookup type fields (e.g. Account, Contact, Owner) for any module. Lookup fields are jsonobject type of fields which has id, name and sometimes email (only for Owner). This example shows how to update using unique field (E.g. email, id or name). Below example shows how to set Owner of the Account (e.g.) 1558554000137221573. We will set owner to bob-the-salesman@abc.com (or you can set by id)

UPDATE Accounts 
SET Owner='{email: "bob-the-salesman@abc.com"}'
--SET Owner='{id: "1558554000186378001"}' --you can also use Id
Where Id='1558554000137221573'

Update Account or Contact (Lookup field) by Name or Id for Deals    [Read more...]

This examples shows how to update Account and Contact field on Deals module. We used name for account and id for contact just to show how unique field can be used.

UPDATE Deals 
SET Account_Name='{"name": "Company ABCD"}',    --by name or id 
    Contact_Name='{"id": "1558554000186378001"}'  --by id 
Where Id='1558554000137221573'

Create a Deal with Lookup fields (e.g. set Account, Contact, Owner etc by Id or Name)    [Read more...]

This examples shows how to create a new record with Lookup field(s) e.g account, contact or owner.

INSERT INTO Deals(
	Deal_name,
	Amount,
	Lead_Source,
	Account_Name,
	Contact_Name,
	Owner
	)
VALUES
   (
   'My Test Deal Creatyed on <<FUN_NOW>>', --deal name
   1000.50, --amount
   'Cold Call', --lead source
   '{name:"ZappySys"}', --account name or use id '{id:"1558554000030180013"}'
   '{id:"1558554000089352998"}' --contact id 
   '{id:"1558554000089352912"}' --owner id or use email {email: "bob-the-salesman@abc.com"}
   )

Read single row by ID    [Read more...]

SELECT * from Accounts Where Id=1558554000105110008

Read reacord(s) modified after certain date    [Read more...]

SELECT * from Accounts WITH(ModifiedSince = '2020-01-07T00:00:00')

Read using COQL (Zoho Serverside Query Language)    [Read more...]

You can write server side query so you dont have to read full data on client side. For COQL LIMIT clause must be 200 or less. For more information check this URL https://zappysys.com/links?url=https://www.zoho.com/crm/developer/docs/api/COQL-Overview.html

SELECT * from get_module_data_coql WITH(sql_query= 'select Last_Name, First_Name, Company from Leads where Company like ''Test'' limit 200')

Update table for specific record    [Read more...]

Update Leads SET Designation='VP Sales', Company='Test' Where id=1558554000012181009

Update table for specific record (older version)    [Read more...]

Update Leads SET id='1558554000012181009' /* id must be supplied */, Designation='VP Sales', Company='Test'

Get accounts modified after certain date    [Read more...]

SELECT * from Accounts Where Account_Name LIKE 'Test%' WITH(ModifiedSince = '2020-01-07T00:00:00')

Search accounts by specific field (server side filter)    [Read more...]

You can use criteria listed here https://www.zoho.com/crm/developer/docs/api/v2/search-records.html

SELECT * FROM search_Accounts WITH(criteria='Account_Name:starts_with:test')

Create a new record    [Read more...]

INSERT INTO Accounts(Account_Name, Phone) VALUES('Company ABC','111-567-8888')

Create a new account record (with show output on / off)    [Read more...]

INSERT INTO Accounts(Account_Name, Phone) VALUES('Company ABC','111-567-8888') WITH(Output=1)

Delete single record by Id    [Read more...]

Delete exising record by Id (single row). You can supply upto 100 comma seperated Ids

DELETE FROM Accounts WHERE id=11111111111

Delete multiple records by Ids    [Read more...]

This example shows how to delete Account Records by multiple Ids. You can supply upto 100 comma seperated Ids

DELETE FROM Accounts WITH(Id='11111,22222,33333')

Upsert account record (Update or Insert - based on unique field(s) for module)    [Read more...]

UPSERT INTO Accounts(Account_Name, Phone) VALUES('Company ABC','111-567-8888') WITH(Output=1)

Upsert lead record (Update or Insert - based on unique field(s) for module)    [Read more...]

UPSERT INTO Leads(Last_Name, Email) VALUES('Patel','zpatel@abc.com') WITH(Output=1)

Create new account(s) in BULK (read / write from external source)    [Read more...]

This examples shows how to use SOURCE clause to read data from MS SQL Server (or other external system) and send data to Zoho using Bulk API

INSERT INTO Accounts
SOURCE(
  'MSSQL' --ODBC or OLEDB
  ,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
  ,'select ''Test Account-A'' as Account_Name,''111-111-1111'' as Phone
    UNION
    select ''Test Account-B'' as Account_Name,''222-222-2222'' as Phone
   '
)

UPSERT (Update or insert) account(s) in BULK (read / write from external source)    [Read more...]

This examples shows how to use SOURCE clause to read data from MS SQL Server (or other external system) and send data to Zoho using Bulk API. Record uniqueness is checked based on Unique field setup for module (i.e. email, account name, phone etc)

UPSERT INTO Accounts
SOURCE(
  'MSSQL' --ODBC or OLEDB
  ,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
  ,'select ''Test Account-A'' as Account_Name,''111-111-1111'' as Phone
    UNION
    select ''Test Account-B'' as Account_Name,''222-222-2222'' as Phone
   '
)

Update Tag(s) for exising records (add or overwrite)    [Read more...]

SELECT * FROM post_tags
WITH(
	  module='Accounts'
	, ids='1558554000105151002'
	, tag_names='mytag1,mytag2'
  , over_write='true'
)

Download for SSIS Download for Other Apps