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.

In this article you will learn how to quickly and efficiently integrate Zoho CRM data in SSIS without coding. We will use high-performance Zoho CRM Connector to easily connect to Zoho CRM and then access the data inside SSIS.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Connect to Zoho CRM in other apps
Zoho CRM Connector Connect Zoho CRM in SQL Server SQL Server
Connect to Zoho CRM in SQL Server
Zoho CRM Connector Connect Zoho CRM in Power BI Power BI
Connect to Zoho CRM in Power BI
Zoho CRM Connector Connect Zoho CRM in SSRS SSRS
Connect to Zoho CRM in SSRS
Zoho CRM Connector Connect Zoho CRM in Informatica Informatica
Connect to Zoho CRM in Informatica
Zoho CRM Connector Connect Zoho CRM in MS Access MS Access
Connect to Zoho CRM in MS Access
Zoho CRM Connector Connect Zoho CRM in MS Excel MS Excel
Connect to Zoho CRM in MS Excel
Zoho CRM Connector Connect Zoho CRM in SSAS SSAS
Connect to Zoho CRM in SSAS
Zoho CRM Connector Connect Zoho CRM in C# C#
Connect to Zoho CRM in C#
Zoho CRM Connector Connect Zoho CRM in Python Python
Connect to Zoho CRM in Python
Zoho CRM Connector Connect Zoho CRM in JAVA JAVA
Connect to Zoho CRM in JAVA
Zoho CRM Connector Connect Zoho CRM in Tableau Tableau
Connect to Zoho CRM in Tableau
Zoho CRM Connector Connect Zoho CRM in SAP Crystal Reports SAP Crystal Reports
Connect to Zoho CRM in SAP Crystal Reports
Zoho CRM Connector Connect Zoho CRM in Azure Data Factory (Pipeline) Azure Data Factory (Pipeline)
Connect to Zoho CRM in Azure Data Factory (Pipeline)
Zoho CRM Connector Connect Zoho CRM in Azure Data Factory (SSIS) Azure Data Factory (SSIS)
Connect to Zoho CRM in Azure Data Factory (SSIS)
Zoho CRM Connector Connect Zoho CRM in Talend Studio Talend Studio
Connect to Zoho CRM in Talend Studio
Zoho CRM Connector Connect Zoho CRM in UiPath UiPath
Connect to Zoho CRM in UiPath
Zoho CRM Connector Connect Zoho CRM in PowerShell PowerShell
Connect to Zoho CRM in PowerShell
Zoho CRM Connector Connect Zoho CRM in ODBC ODBC
Connect to Zoho CRM in ODBC

Video Tutorial - Integrate Zoho CRM data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Zoho CRM integration in SSIS
  • How to configure the connection for Zoho CRM
  • Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
  • How to use the Zoho CRM in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

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 [OAuth]

    OAuth Connection for Zoho CRM API [API reference]

    Steps how to get and use 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.

    Configuring authentication parameters
    Zoho CRM
    OAuth [OAuth]
    https://www.zohoapis.com/crm/[$Version$]
    Optional Parameters
    ClientId
    ClientSecret
    Permissions ZohoCRM.settings.all ZohoCRM.modules.all ZohoCRM.coql.READ
    AccountUrl https://accounts.zoho.com
    RedirectUrl https://zappysys.com/oauth
    API Version v2
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    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

Write data to Zoho CRM using SSIS (Import data)

In this section we will learn how to configure and use Zoho CRM Connector in the API Destination to write data to Zoho CRM.

Video tutorial

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

Step-by-step instructions

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 [OAuth]

    OAuth Connection for Zoho CRM API [API reference]

    Steps how to get and use 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.

    Configuring authentication parameters
    Zoho CRM
    OAuth [OAuth]
    https://www.zohoapis.com/crm/[$Version$]
    Optional Parameters
    ClientId
    ClientSecret
    Permissions ZohoCRM.settings.all ZohoCRM.modules.all ZohoCRM.coql.READ
    AccountUrl https://accounts.zoho.com
    RedirectUrl https://zappysys.com/oauth
    API Version v2
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    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

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

Once you configured the data source, you can load Zoho CRM data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table

  9. Click OK to save the configuration.

  10. Run the package and Zoho CRM data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

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

  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Actions supported by Zoho CRM Connector

Zoho CRM Connector supports following actions for REST API integration:

Add / Update Tags for records

Description

Add tags for specified module and specified record id(s).

Parameters

You can provide the following parameters to this action:

  • module
  • Record Id(s) (comma seperated list)
  • Tag Id
  • Overwrite

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • id
  • code
  • message
  • status
  • tags

Visit documentation for more information.

Delete [Dynamic Action]

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Record ID(s) - Use Comma for multiple (e.g. 111,222)
  • Fire Wordflow Trigger

Input Fields

You can provide the following fields to this action:

  • id

Output Fields

The following fields are returned after calling this action:

  • id
  • code
  • message
  • status

Visit documentation for more information.

Gets record count for specific tag for module

Description

Add tags for specified module and specified record id(s).

Parameters

You can provide the following parameters to this action:

  • module
  • Tag Id

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Count

Visit documentation for more information.

Insert [Dynamic Action]

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Triggers

Input Fields

You can provide the following fields to this action:

  • -Dynamic-

Output Fields

The following fields are returned after calling this action:

  • id
  • code
  • message
  • status
  • expected_data_type
  • api_name
  • created_time
  • modified_time
  • modified_by_name
  • modified_by_id
  • created_by_name
  • created_by_id

Visit documentation for more information.

List Module Fields

Description

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.

Parameters

You can provide the following parameters to this action:

  • module

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

List Module Settings

Description

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.

Parameters

You can provide the following parameters to this action:

  • module

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

List Modules

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

List Tags

Description

List tags for module.

Parameters

You can provide the following parameters to this action:

  • module

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • Name
  • Created_By_Id
  • Created_By_Name
  • Created_Time
  • Modified_Time

Visit documentation for more information.

List Territories

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

List Views

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • module

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Read [Dynamic Action]

Description

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).

Parameters

You can provide the following parameters to this action:

  • Module
  • Fetch records modified after (local time format: yyyy-MM-ddTHH:mm:ss)
  • Custom View ID
  • Fields (Only for V2 API)
  • sort_by
  • sort_order
  • territory_id
  • include_child
  • converted
  • Return Approved Records
  • PageSize

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • -Dynamic-
  • [Dynamic Column]
  • [Dynamic Column]_Id
  • Created_By_Id
  • Created_By_Email
  • Created_By_Name
  • Modified_By_Id
  • Modified_By_Email
  • Modified_By_Name
  • Owner_Id
  • Owner_Email
  • Owner_Name
  • $approval_state
  • $approved
  • $state

Visit documentation for more information.

Read [Dynamic Action] (Use this for fewer than 50 Fields in v3+)

Description

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).

Parameters

You can provide the following parameters to this action:

  • Module
  • Fetch records modified after (local time format: yyyy-MM-ddTHH:mm:ss)
  • Custom View ID
  • Fields (Only for V2 API)
  • sort_by
  • sort_order
  • territory_id
  • include_child
  • converted
  • Return Approved Records
  • PageSize

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • -Dynamic-
  • [Dynamic Column]
  • [Dynamic Column]_Id
  • Created_By_Id
  • Created_By_Email
  • Created_By_Name
  • Modified_By_Id
  • Modified_By_Email
  • Modified_By_Name
  • Owner_Id
  • Owner_Email
  • Owner_Name
  • $approval_state
  • $approved
  • $state

Visit documentation for more information.

Read Data (Query Mode - Max 200 Rows Only)

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • sql_query

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Search [Dynamic Action]

Description

Search records by criteria or email or phone or word or id (specify only one parameter for search and keep other blank).

Parameters

You can provide the following parameters to this action:

  • Search By Criteria Expression
  • Search By Email
  • Search By Phone
  • Search By any Word
  • Search By Id
  • Include only converted records
  • Include approved records
  • PageSize

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Id
  • -Dynamic-
  • [Dynamic Column]
  • [Dynamic Column]_Id
  • Created_By_Id
  • Created_By_Email
  • Created_By_Name
  • Modified_By_Id
  • Modified_By_Email
  • Modified_By_Name
  • Owner_Id
  • Owner_Email
  • Owner_Name
  • $approval_state
  • $approved
  • $state

Visit documentation for more information.

Update [Dynamic Action]

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Triggers

Input Fields

You can provide the following fields to this action:

  • id
  • -Dynamic-

Output Fields

The following fields are returned after calling this action:

  • id
  • code
  • message
  • status
  • expected_data_type
  • api_name
  • created_time
  • modified_time
  • modified_by_name
  • modified_by_id
  • created_by_name
  • created_by_id

Visit documentation for more information.

Upsert [Dynamic Action] (Update or Insert)

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • Triggers
  • Duplicate_Check_Fields

Input Fields

You can provide the following fields to this action:

  • -Dynamic-

Output Fields

The following fields are returned after calling this action:

  • id
  • code
  • message
  • status
  • duplicate_field
  • expected_data_type
  • api_name
  • modified_time
  • modified_by_name
  • modified_by_id
  • created_time
  • created_by_name
  • created_by_id

Visit documentation for more information.

Make Generic API Request

Description

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.

Parameters

You can provide the following parameters to this action:

  • Url
  • Body
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Make Generic API Request (Bulk Write)

Description

This is a generic endpoint for bulk write purpose. 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.

Parameters

You can provide the following parameters to this action:

  • Url
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Conclusion

In this article we showed you how to connect to Zoho CRM in SSIS and integrate data without any coding, saving you time and effort.

We encourage you to download Zoho CRM Connector for SSIS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Zoho CRM Connector for SSIS Documentation

More integrations

Other connectors for SSIS

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Zoho CRM

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications
Download Zoho CRM Connector for SSIS Documentation