> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useparagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM

## 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](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Zoho CRM supports the following Synced Objects:

* [Contacts](/managed-sync/api/contact-schema)
* [Companies](/managed-sync/api/company-schema)
* [Deals](/managed-sync/api/deal-schema)
* [Custom Objects](/managed-sync/api/custom-object-schema)

## Contacts

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "zohocrm",
    "pipeline": "contacts",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField path="backoffAtCreditPercentage" type="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.
</ParamField>

## Companies

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "zohocrm",
    "pipeline": "companies",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField path="backoffAtCreditPercentage" type="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.
</ParamField>

## Deals

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "zohocrm",
    "pipeline": "deals",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField path="backoffAtCreditPercentage" type="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.
</ParamField>

## Custom Objects

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "zohocrm",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "Subscriptions",
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField path="customObjectName" type="string" required>
  The Zoho module API name to sync, e.g., `Subscriptions`.
</ParamField>

<ParamField path="backoffAtCreditPercentage" type="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.
</ParamField>