Skip to main content

​
Required Scopes

To configure a Sync for Zoho CRM, you need to request the following scopes from your Zoho OAuth application: All pipelines:
  • ZohoCRM.modules.READ
  • ZohoCRM.users.READ
  • ZohoCRM.bulk.READ
  • ZohoCRM.settings.fields.READ
  • ZohoCRM.org.READ (required if using backoffAtCreditPercentage)
Contacts:
  • ZohoCRM.modules.contacts.READ
Companies:
  • ZohoCRM.modules.accounts.READ
Deals:
  • ZohoCRM.modules.deals.READ
Learn more about configuring scopes for your app in Adding Integrations.

​
Synced Objects

Zoho CRM supports the following Synced Objects:

​
Contacts

​
Sync Configuration Options

Example
{
    "integration": "zohocrm",
    "pipeline": "contacts",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
​
backoffAtCreditPercentage
number
When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily API credit allotment, trying again at an hourly frequency until API credits are available again. This can help to prevent exhausting API usage limits with large syncs.This value can be set between 0.5 (stop at 50% API utilization) and 1.0 (100% API utilization).Note: The OAuth application must use the ZohoCRM.org.READ scope to use this feature.

​
Companies

​
Sync Configuration Options

Example
{
    "integration": "zohocrm",
    "pipeline": "companies",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
​
backoffAtCreditPercentage
number
When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily API credit allotment, trying again at an hourly frequency until API credits are available again. This can help to prevent exhausting API usage limits with large syncs.This value can be set between 0.5 (stop at 50% API utilization) and 1.0 (100% API utilization).Note: The OAuth application must use the ZohoCRM.org.READ scope to use this feature.

​
Deals

​
Sync Configuration Options

Example
{
    "integration": "zohocrm",
    "pipeline": "deals",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
​
backoffAtCreditPercentage
number
When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily API credit allotment, trying again at an hourly frequency until API credits are available again. This can help to prevent exhausting API usage limits with large syncs.This value can be set between 0.5 (stop at 50% API utilization) and 1.0 (100% API utilization).Note: The OAuth application must use the ZohoCRM.org.READ scope to use this feature.

​
Custom Objects

​
Sync Configuration Options

Example
{
    "integration": "zohocrm",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "Subscriptions",
        "backoffAtCreditPercentage": 0.8
    }
}
​
customObjectName
string
required
The Zoho module API name to sync, e.g., Subscriptions.
​
backoffAtCreditPercentage
number
When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily API credit allotment, trying again at an hourly frequency until API credits are available again. This can help to prevent exhausting API usage limits with large syncs.This value can be set between 0.5 (stop at 50% API utilization) and 1.0 (100% API utilization).Note: The OAuth application must use the ZohoCRM.org.READ scope to use this feature.