Zoho Campaigns is an email marketing platform that businesses use to create and send email campaigns, manage mailing lists and contacts, automate follow-ups through workflows, and track how each campaign performs.
Hevo uses the Zoho Campaigns API to replicate the mailing lists, contacts, campaigns, campaign reports, and other marketing data of your Zoho Campaigns account to the Destination of your choice. Hevo connects to Zoho Campaigns using OAuth 2.0 with a Zoho API client that you register. To ingest data, you must provide Hevo with the Client ID and Client Secret of the API client and the data center region of your Zoho account, and then authorize Hevo to read your data.
Supported Features
| Feature Name |
Supported |
| Capture deletes |
Yes |
| History mode |
No |
| Custom data (user-configured tables & fields) |
No |
| Data blocking (skip objects and fields) |
Yes |
| Resync (objects and Pipelines) |
Yes |
| API configurable |
Yes |
Prerequisites
-
An active Zoho Campaigns account exists from which data is to be ingested.
-
The Zoho user who authorizes Hevo is an Admin of your Zoho Campaigns organization. Hevo replicates only the mailing lists, campaigns, and workflows that this user can view. For example, a user with the Member role can view only the data that they created.
-
A Zoho API client is registered, and its Client ID and Client Secret are available.
Create a Zoho API Client
Hevo connects to Zoho Campaigns through an OAuth client that you register in the Zoho API Console. Register the client in the API Console of the data center where your Zoho account is hosted, for example, https://api-console.zoho.com for the US data center or https://api-console.zoho.in for the India data center.
Perform the following steps to create an API client:
-
Log in to the Zoho API Console with the Zoho account that you use to access Zoho Campaigns.
-
On the Applications page, click ADD CLIENT. If you have not created a client before, Zoho displays the client types directly.

-
On the Choose a Client Type page, click CREATE NOW in the Server-based Applications card.

-
On the Create New Client page, specify the following, and then click CREATE:

-
Client Name: A name for the client. For example, Hevo Campaigns Connector.
-
Homepage URL: The URL of your company website. For example, https://hevodata.com.
-
Authorized Redirect URIs: https://westeros.hevodata.com/edge/oauth/callback. Hevo returns to this URL after you authorize it to read your Zoho Campaigns data. Enter it exactly as shown, without a trailing slash.
-
Click the Client Secret tab, and then copy the Client ID and the Client Secret and save them securely like any other password.

Use these credentials when configuring your Zoho Campaigns Source in Hevo.
If you delete the API client, regenerate its Client Secret, or revoke the access granted to Hevo in your Zoho account, Hevo cannot authenticate with Zoho Campaigns. As a result, all active jobs for the Pipeline fail, and no data is replicated. To resume data replication, modify the Source configuration in the Pipeline with valid credentials and authorize Hevo again. Once the updated configuration is saved, Hevo re-authenticates the Source, and data ingestion resumes.
Scopes Required by Hevo
When you authorize Hevo, Zoho asks you to grant the following read-only scopes. Hevo uses each Zoho Campaigns scope to read the objects listed against it:
| Scope |
Objects |
ZohoCampaigns.campaign.READ |
- Recent Campaign - Associated Mailing List - Campaign - Campaign Detail - Campaign Location - Campaign Reach - Campaign Recipient Data - Campaign Report - Segment Info |
ZohoCampaigns.contact.READ |
- Mailing List - Advanced Campaign Detail - Contact - Contact Count - List Advanced Detail - Segment - Contact Field - Product - Topic |
ZohoCampaigns.workflow.READ |
- Workflow |
AaaServer.profile.Read |
None. Hevo uses this scope only to display the email address of the Zoho account that authorized the connection. |
Perform the following steps to configure your Zoho Campaigns Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Zoho Campaigns.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
In the Configure Source screen, specify the following:

-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Zoho Campaigns Source.
-
In the Connect to Zoho Campaigns section:
-
Data Center Region: The data center where your Zoho account is hosted. From the drop-down, select one of the following: United States (zoho.com), Europe (zoho.eu), India (zoho.in), Australia (zoho.com.au), Japan (zoho.jp), Saudi Arabia (zoho.sa), Singapore (zoho.sg), United Arab Emirates (zoho.ae), United Kingdom (zoho.uk), or China (zoho.com.cn). Default value: United States (zoho.com). The region must match the domain of the Zoho API Console in which you created the API client.
Note: Hevo does not support Zoho accounts hosted in the Canada data center (zohocloud.ca).
-
Client ID: The Client ID of the API client that you created.
-
Client Secret: The Client Secret of the API client.
-
Click Authorize, log in to your Zoho account if prompted, and then grant Hevo the requested scopes.
-
Click Test & Continue to test the connection to your Zoho Campaigns Source. Hevo checks that it can read the mailing lists of your Zoho Campaigns account with the authorization you granted. Once the test is successful, you can proceed to set up your Destination.
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline. You can select or deselect each child object independently of its parent object. The Data Model lists the child objects of each parent object.
The Associated Mailing List, Campaign Detail, Campaign Reach, Campaign Report, and Segment Info objects are ingested along with the Campaign object. You cannot resync these objects individually. To resync them, resync the Campaign object.
Hevo ingests the following types of data from your Source objects:
-
Historical Data: The first run of the Pipeline ingests all the existing data for the selected objects and loads it into the Destination.
-
Incremental Data: The Zoho Campaigns API does not provide a way to fetch only the records created or updated since the last run. Therefore, Hevo ingests the entire data of all the selected objects in each Pipeline run, as per the sync frequency.
Zoho Campaigns allows 500 API calls in 5 minutes for each API, and 100 API calls in 5 minutes for the API that fetches contact fields. If this limit is exceeded, Zoho locks the API for 30 minutes. API calls made by other applications using your Zoho Campaigns account also count toward this limit. Hevo paces its calls to stay within the limit. If Zoho Campaigns rejects a request during a Pipeline run, Hevo does not load partial data for the affected object and reads the object again in the next run. To understand how Hevo handles rate limit exceptions, read Handling Rate Limit Exceptions.
Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object |
Description |
| Contact Field |
Contains the default and custom contact fields defined in your Zoho Campaigns account, such as the display name, type, and whether the field is mandatory. |
| Mailing List |
Contains the mailing lists in your Zoho Campaigns account, such as the list name, description, owner, creation time, and contact, unsubscribe, and bounce counts. It includes the following child objects: - Advanced Campaign Detail - Contact - Contact Count - List Advanced Detail - Segment
The Contact object contains only the active contacts of each mailing list. Contacts who have unsubscribed from a list are not ingested. |
| Product |
Contains the products defined in your Zoho Campaigns account, with the ID and name of each product. This table contains data only if the topics in your Zoho Campaigns organization use the Brand – Product – Topic hierarchy. With the default Brand – Topic hierarchy, the table remains empty. |
| Recent Campaign |
Contains the campaigns in your Zoho Campaigns account, such as the campaign name, type, status, sender, subject, and created and sent times. It includes the following child objects: - Associated Mailing List - Campaign - Campaign Detail - Campaign Location - Campaign Reach - Campaign Recipient Data - Campaign Report - Segment Info |
| Topic |
Contains the topics defined in your Zoho Campaigns account, including the name, description, and primary list of each topic. |
| Workflow |
Contains the custom workflows in your Zoho Campaigns account, with the key, name, trigger key, and creation time of each workflow. |
Read the detailed Hevo documentation for the following related topics:
Handling of Deletes
Zoho Campaigns does not mark deleted records in its API responses. Hevo uses a full data refresh approach to capture delete actions for all objects, including the child objects. During each Pipeline run, Hevo ingests the complete data of each object and compares it with the data present in the Destination table. If a record exists in the Destination but is no longer returned by the Source, the record is marked as deleted by setting the value of the metadata column _hevo_marked_deleted to True. The record remains in the Destination table.
For example, when you delete a mailing list in Zoho Campaigns, Hevo marks the mailing list and its contacts as deleted in the Destination tables in the next Pipeline run.