Zoho CRM Connector for SSIS

Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
You can use this connector to integrate Zoho CRM data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download Documentation

Video Tutorial - Integrate Zoho CRM data in SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download / install required driver for Zoho CRM integration in SSIS
  • How to configure connection for Zoho CRM
  • Features about API Source (Authentication / Query Language / Examples / Driver UI)
  • Using Zoho CRM Connection in SSIS

Prerequisites

Before we perform steps listed in this article, you will need to make sure following prerequisites are met:
  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
  4. Optional (If you want to Deploy and Schedule ) - Deploy and Schedule SSIS Packages

How to read data from Zoho CRM in SSIS (Export data)

In this section we will learn how to configure and use Zoho CRM Connector in API Source to extract data from Zoho CRM.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Zoho CRM Connector from Popular Connector List or press Search Online radio button to download Zoho CRM Connector. Once downloaded simply use it in the configuration:

    Zoho CRM
    Zoho CRM Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    OAuth Connection for Zoho CRM API [API Help..]

    Steps to get Zoho CRM Credentials : OAuth [OAuth]
    To register custom App, perform the following steps (Detailed steps found in the help link at the end)
    1. Go to Zoho API Console
    2. Click Add Client link
    3. Select Server-based Applications option
    4. Enter desired client name (Display purpose only)
    5. Enter some URL for Company homepage
    6. For Authorized Redirect URI enter https://zappysys.com/oauth (Or enter your own but we recommend using ZappySys one if possible). This URL must match on Zoho Connector UI.
    7. Click CREATE.
    8. Copy Client ID and Secret and paste on Zoho Connector UI.
    Zoho CRM
    OAuth [OAuth]
    https://www.zohoapis.com/crm/[$Version$]
    Required Parameters
    Optional Parameters
    ClientId Fill in the parameter...
    ClientSecret Fill in the parameter...
    Permissions Fill in the parameter...
    AccountUrl Fill in the parameter...
    RedirectUrl Fill in the parameter...
    API Version Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Source - Select Endpoint

  10. That's it! We are done! Just in a few clicks we configured the call to Zoho CRM using Zoho CRM Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Zoho CRM and load into target

Load Zoho CRM data in SQL Server using Upsert Destination (Insert or Update)

Once you read data from the desired source, now let's see how to Load Zoho CRM data in SQL Server using Upsert Destination. Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.

  1. From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface

  2. Connect our Source component to Upsert Destination

  3. Double click on Upsert Destination component to configure it.

  4. Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS

  5. Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
    SSIS SQL Upsert option

  6. Click on OK to save Upsert Destination settings UI.

  7. That's it. Run the SSIS Package and it will read the data from the Zoho CRM and load the data in the SQL Server/PostgreSql/Redshift using Upsert Destination.

    Execute Package - Reading data from API Source and load into target

Video Tutorial - Write or lookup data to Zoho CRM using SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Zoho CRM integration in SSIS
  • How to configure connection for Zoho CRM
  • How to Write or lookup data to Zoho CRM
  • Features about SSIS API Destination
  • Using Zoho CRM Connector in SSIS

How to write or lookup data to Zoho CRM in SSIS (Import data)

In upper section we learned how to read data, now in this section we will learn how to configure Zoho CRM in the API Source to Post data to the Zoho CRM.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Destination - New Connection

  4. Use a preinstalled Zoho CRM Connector from Popular Connector List or press Search Online radio button to download Zoho CRM Connector. Once downloaded simply use it in the configuration:

    Zoho CRM
    Zoho CRM Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    OAuth Connection for Zoho CRM API [API Help..]

    Steps to get Zoho CRM Credentials : OAuth [OAuth]
    To register custom App, perform the following steps (Detailed steps found in the help link at the end)
    1. Go to Zoho API Console
    2. Click Add Client link
    3. Select Server-based Applications option
    4. Enter desired client name (Display purpose only)
    5. Enter some URL for Company homepage
    6. For Authorized Redirect URI enter https://zappysys.com/oauth (Or enter your own but we recommend using ZappySys one if possible). This URL must match on Zoho Connector UI.
    7. Click CREATE.
    8. Copy Client ID and Secret and paste on Zoho Connector UI.
    Zoho CRM
    OAuth [OAuth]
    https://www.zohoapis.com/crm/[$Version$]
    Required Parameters
    Optional Parameters
    ClientId Fill in the parameter...
    ClientSecret Fill in the parameter...
    Permissions Fill in the parameter...
    AccountUrl Fill in the parameter...
    RedirectUrl Fill in the parameter...
    API Version Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Zoho CRM API call using ZappySys Zoho CRM Connector

    Execute Package - Reading data from API Source and load into target

Advanced topics

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

Conclusion

In this article we discussed how to connect to Zoho CRM in SSIS and integrate data without any coding. Click here to Download Zoho CRM Connector for SSIS and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Zoho CRM Connector for SSIS Documentation 

More integrations

Other application integration scenarios for Zoho CRM

Other connectors for SSIS


Download Zoho CRM Connector for SSIS Documentation

  • How to connect Zoho CRM in SSIS?

  • How to get Zoho CRM data in SSIS?

  • How to read Zoho CRM data in SSIS?

  • How to load Zoho CRM data in SSIS?

  • How to import Zoho CRM data in SSIS?

  • How to pull Zoho CRM data in SSIS?

  • How to push data to Zoho CRM in SSIS?

  • How to write data to Zoho CRM in SSIS?

  • How to POST data to Zoho CRM in SSIS?

  • Call Zoho CRM API in SSIS

  • Consume Zoho CRM API in SSIS

  • Zoho CRM SSIS Automate

  • Zoho CRM SSIS Integration

  • Integration Zoho CRM in SSIS

  • Consume real-time Zoho CRM data in SSIS

  • Consume real-time Zoho CRM API data in SSIS

  • Zoho CRM ODBC Driver | ODBC Driver for Zoho CRM | ODBC Zoho CRM Driver | SSIS Zoho CRM Source | SSIS Zoho CRM Destination

  • Connect Zoho CRM in SSIS

  • Load Zoho CRM in SSIS

  • Load Zoho CRM data in SSIS

  • Read Zoho CRM data in SSIS

  • Zoho CRM API Call in SSIS