Zoho CRM

ExpandedToggleIcon        Connection Dialog

Devart SSIS Data Flow Components support API v2 to connect to Zoho CRM. Note that Zoho CRM API v1 was deprecated on Dec 31, 2018.


To connect to Zoho CRM, you need to specify the following parameter:

1.Domain - select whether you connect to crm.zoho.com or to crm.zoho.eu or to crm.zoho.in or to crm.zoho.com.cn.
2.Refresh Token - a renewed access token. Click Web Login and sign in to Zoho CRM. The renewed token is assigned automatically.


In addition to the required options, Advanced connection options may be set for more fine connection tuning.


ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:




API Version

The version of Zoho CRM API to use. Note that API v1 has already reached End-of-Life.

Client Id

A unique identifier provided to every Zoho CRM client application when a Zoho CRM client application is registered with Zoho. This parameter is used for connecting via API v2, and is filled automatically when you perform Web Login.

Client Secret

A secret code, mapped to a Zoho CRM client application. This parameter is used for connecting via API v2, and is filled automatically when you perform Web Login.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.

Default Command Timeout

The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.


Zoho CRM domain base URL. Can be crm.zoho.com or crm.zoho.eu or crm.zoho.in or crm.zoho.com.cn or crm.zoho.com.au.

Local SQL Engine

Determines whether to enable local SQL processing (enabled by default). Local SQL processing allows performing complex SELECT statements that cannot be directly compiled to Zoho CRM API calls. In this case ll the data from the mentioned cloud objects is queried to the local cache, and then the query is performed against the cache.

If local SQL processing is disabled, only simple SELECT statements that can be directly translated into Zoho CRM API calls can be used. More complex SELECT statements will fail.

Max Pool Size

The maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

The minimum number of connections allowed in the pool. The default value is 0.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.


If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

The port number of the proxy server. The default value is 3128.

Proxy User

The proxy server account name.


Indicates whether the connection is read-only (allows only SELECT statements).

Refresh Token

Zoho CRM OAuth refresh token, used for connecting via API v2.

Security Token

Zoho CRM Authentication Token, used for connecting via API v1.

Token Server

SSIS Data Flow Components for Zoho CRM can query new refresh tokens automatically when the current one expires and store them between sessions if you set this parameter. This parameter specifies the location to store new tokens between sessions. You can specify a file or a registry key to store tokens. For example, "file://D:\temp\oauth_token_1234.txt" or "reg://HKEY_CURRENT_USER\Software\Devart\dotConnect\OAuth_12345"

Trigger Workflow

Determines whether to trigger the workflow rule when inserting or updating data.

Upgrade Cache

Determines whether to upgrade the local cache database or to throw an exception in case when Devart SSIS Data Flow Components version that uses a newer cache structure or newer version of Zoho CRM API discovers an old incompatible cache for the connection that is opening.

Use Display Name For Custom Tables

Determines whether display names are used to access custom Zoho CRM modules instead of the module names.

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered by the user (in SELECT statements, etc.) are considered UTC dates when sending them to the data source.

Zoho Time Zone

The timezone that is specified in your Zoho CRM account settings.