Skip to main content

Zoho Campaigns

Zoho Campaigns is an email marketing platform for creating, sending, and tracking email campaigns and managing subscriber lists. This connector uses the Zoho Campaigns REST API to read campaign, subscriber, and mailing list data into Nexla, and to write contacts and list updates back to Zoho Campaigns.

Zoho Campaigns icon

Power end-to-end data operations for your Zoho Campaigns API with Nexla. Our bi-directional Zoho Campaigns connector is purpose-built for Zoho Campaigns, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Zoho Campaigns or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Zoho Campaigns workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Zoho Campaigns uses OAuth 2.0 (authorization code). Nexla runs the sign-in flow for you, but it needs a client that you register in the Zoho API Console. Complete the following steps before creating a credential in Nexla.

  1. Sign in to the Zoho API Console with a Zoho account that can access your Zoho Campaigns organization.

  2. Click Add Client (or Get Started if this is your first client) and choose Server-based Applications.

  3. Enter a Client Name and a Homepage URL, and set the Authorized Redirect URIs to https://dataops.nexla.io/nexla-api/oauth/callback. The redirect URI must match exactly, or Zoho rejects the sign-in.

  4. Click Create. Zoho shows the client's Client ID and Client Secret; copy both, and keep the secret confidential.

  5. Note your Zoho data center. Open Zoho Campaigns in your browser and check the domain: campaigns.zoho.com is the US data center, and .eu, .in, .com.au, .jp, and .com.cn are the others. The credential's defaults are for the US data center.

For details, see Zoho's guides to registering a client, Zoho Campaigns OAuth and scopes, and data centers.

Authenticate​

Credentials required​

An OAuth authentication flow where users must authorize an application to access their Zoho Campaigns data

FieldRequiredSecretDescription
Base URLYesNoZoho Campaigns API base URL (region-specific, e.g. https://campaigns.zoho.com/api/v1.1).
Authorization URLNoNoThe URL endpoint where users authenticate and authorize access
Client IDYesYesA unique public identifier assigned to your Zoho application
Access ScopeNoNoComma-separated Zoho OAuth scopes, e.g. ZohoCampaigns.contact.ALL,ZohoCampaigns.campaign.ALL.
Token URLNoNoThe URL endpoint where authorization codes are exchanged for access tokens
Client SecretNoYesA private key used to authenticate your application when requesting tokens

Zoho expects scopes as a comma-separated list. The default Access Scope, ZohoCampaigns.contact.ALL,ZohoCampaigns.campaign.ALL, grants read and write access to contacts, mailing lists, and campaigns. If you narrow the scopes, templates that need an omitted scope will fail.

The Authorization URL, Token URL, and Base URL default to the US data center (https://accounts.zoho.com/oauth/v2/auth, https://accounts.zoho.com/oauth/v2/token, and https://campaigns.zoho.com/api/v1.1). For an account in another data center, replace .com with your data center's domain in all three, for example https://accounts.zoho.eu/oauth/v2/auth, https://accounts.zoho.eu/oauth/v2/token, and https://campaigns.zoho.eu/api/v1.1 for the EU.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the Client ID and Client Secret of your Zoho API Console client.

  4. Leave the Base URL, Authorization URL, and Token URL at their defaults for a US account, or change them to your data center as described above.

  5. Optionally, adjust the Access Scope.

  6. Click the Authorize button. A Zoho sign-in window opens. Sign in as the Zoho user whose Zoho Campaigns data Nexla should access, review the requested permissions, and click Accept. The window closes and returns you to the overlay.

    Nexla asks Zoho for offline access and for the consent screen on every authorization, so Zoho issues a refresh token. Zoho access tokens expire after one hour, and Nexla renews them with the refresh token, so you do not need to re-authorize under normal use.

  7. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by reading one mailing list from Zoho Campaigns. The credential can only read or change what the authorizing Zoho user can access.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Zoho Campaigns connector tile, then select the credential that will be used to connect to Zoho Campaigns, and click Next; or, create a new Zoho Campaigns credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Zoho Campaigns endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Most templates read one mailing list, segment, or campaign. Start with List Mailing Lists to find list keys and segment IDs, and List Recent Campaigns to find campaign keys.

List Mailing Lists

This endpoint template lists every mailing list in the organization, with its list key, name, owner, contact, unsubscribe and bounce counts, segments, and created date. Results are fetched in pages of 100 lists.

List Mailing List Contacts

This endpoint template lists the contacts of one mailing list, with email address, first and last name, company, and phone. Results are fetched in pages of 100 contacts.

  • Enter the List Key of the mailing list. Use the List Mailing Lists template to find it (the listkey of each list).
  • Select the Contact Status to return: active (default), recent, mostrecent, unsub, or bounce.
  • Vendor reference: Zoho Campaigns API: Get list subscribers.

Get List Contact Count

This endpoint template returns the number of contacts in one mailing list that have a given status, in the no_of_contacts field.

  • Enter the List Key of the mailing list. Use the List Mailing Lists template to find it (the listkey of each list).
  • Select the Contact Status to count: active (default), unsub, bounce, or spam.
  • Vendor reference: Zoho Campaigns API: View total contacts.

Get List Advanced Details

This endpoint template returns advanced statistics for one mailing list: contact counts by status, the campaigns sent to the list, and opens broken down by location, email client, browser, device, and operating system.

  • Enter the List Key of the mailing list. Use the List Mailing Lists template to find it (the listkey of each list).
  • Select the Campaign Filter that controls which campaigns are included: sentcampaigns (default), scheduledcampaigns, or recentcampaigns.
  • Vendor reference: Zoho Campaigns API: List advanced details.

Get Segment Details

This endpoint template returns the criteria of one list segment: its columns, comparators, values, and logical operators.

  • Enter the List Key of the mailing list. Use the List Mailing Lists template to find it (the listkey of each list).
  • Enter the Segment ID (cvid). Segment IDs are listed in the segments field of each list returned by the List Mailing Lists template.
  • Vendor reference: Zoho Campaigns API: Get segment details.

List Segment Contacts

This endpoint template lists the contacts in one segment, with email address, first and last name, company, phone, and the time each contact was added. Results are fetched in pages of 20 contacts.

List Contact Fields

This endpoint template lists every contact field in the organization, default and custom, with its display name, field name, and field ID. The display names are the keys to use in contactinfo when you subscribe or unsubscribe contacts.

List Recent Campaigns

This endpoint template lists campaigns, newest first, with each campaign's key, name, status, created time, and preview URL. Results are fetched in pages of 100 campaigns.

  • Select the Campaign Status to return: all (default), drafts, scheduled, inprogress, sent, stopped, canceled, tobereviewed, reviewed, paused, or intesting.
  • Vendor reference: Zoho Campaigns API: Recent campaign.

List Recently Sent Campaigns

This endpoint template lists the most recently sent campaigns, with each campaign's key, name, sent time, and created time.

Get Campaign Details

This endpoint template returns the details of one campaign: its status, subject, sender, associated mailing lists, reach, and report counts such as opens, clicks, bounces, and unsubscribes.

  • Enter the Campaign Key. Use the List Recent Campaigns template to find it (the campaign_key of each campaign).
  • Select the Campaign Type: normal (default) for a regular campaign, or abtesting for an A/B test campaign.
  • Vendor reference: Zoho Campaigns API: Campaign details.

Get Campaign Report

This endpoint template returns the report of one sent campaign: delivered, open, unique click, bounce, unsubscribe, spam, and forward counts and percentages, plus reach and campaign details.

Get Last Campaign Report

This endpoint template returns the report of the most recently sent campaign, with delivered, open, click, bounce, unsubscribe, and spam counts and the campaign's details.

List Campaign Recipients

This endpoint template lists the recipients of a sent campaign who fall into one group, with each recipient's email address, name, and sent time. Results are fetched in pages of 20 recipients.

  • Enter the Campaign Key. Use the List Recent Campaigns template to find it (the campaign_key of each campaign).
  • Select the Recipient Group: sentcontacts (default), openedcontacts, unopenedcontacts, clickedcontacts, optoutcontacts, spamcontacts, senthardbounce, sentsoftbounce, or unsentcontacts.
  • Vendor reference: Zoho Campaigns API: Campaign recipient data.

List All Tags

This endpoint template lists the organization's contact tags, with each tag's name, description, color, owner, number of tagged contacts, and created time. Each record is keyed by the tag's ID.

List Topics

This endpoint template lists the organization's topics, which group contacts by subscription interest, with each topic's ID, name, description, and primary list.

List Products

This endpoint template lists the products defined for brand-product topics, with each product's ID and name.

Get Coupon Details

This endpoint template returns the details of one coupon: its code, recipient, coupon campaign, sent and expiry dates, status, and the date it was used.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Zoho Campaigns data sources can also be manually configured to ingest data from any valid Zoho Campaigns API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers. Zoho Campaigns endpoint URLs take the form https://campaigns.zoho.com/api/v1.1/... (with your data center's domain); add resfmt=JSON to receive JSON. See the Zoho Campaigns API documentation for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Zoho Campaigns data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Zoho Campaigns destination, and select the Send to Destination option from the menu. Select the Zoho Campaigns connector from the list of available destination connectors, then select the credential that will be used to connect to Zoho Campaigns, and click Next; or, create a new Zoho Campaigns credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Zoho Campaigns endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each record in the Nexset is sent as one request, one record at a time. Except for the four tag templates, which send GET requests with the values in the URL, each record's fields are sent as form fields. Values that Zoho expects as JSON, such as contactinfo, list_details, and campaigninfo, must be JSON strings inside the record.

No template sends or schedules a campaign. Create Draft Campaign and Clone Campaign create drafts; send them from Zoho Campaigns.

Subscribe Contact

This endpoint template adds one contact to a mailing list for each record.

  • Each record must include listkey and contactinfo, a JSON string of contact fields keyed by display name, for example {"listkey": "...", "contactinfo": "{\"Contact Email\":\"jane@example.com\",\"First Name\":\"Jane\"}"}. source and topic_id are optional. Use the List Contact Fields source template to find field display names.
  • Side effect: Zoho Campaigns can send the contact an opt-in confirmation email, for example when the list uses a sign-up form.
  • Vendor reference: Zoho Campaigns API: Contact subscribe.

Unsubscribe Contact

This endpoint template unsubscribes one contact from a mailing list for each record.

  • Each record must include listkey and contactinfo, a JSON string such as {"Contact Email":"jane@example.com"}. topic_id is optional.
  • Side effect: the contact stops receiving campaigns sent to that list.
  • Vendor reference: Zoho Campaigns API: Contact unsubscribe.

Add New List and Contacts

This endpoint template creates a new mailing list with up to 10 contacts for each record.

  • Each record must include listname, signupform (public or private), and emailids, a comma-separated string of up to 10 email addresses. listdescription is optional.
  • Vendor reference: Zoho Campaigns API: Add new list contact.

Add Contacts to Existing List

This endpoint template adds up to 10 email addresses to an existing mailing list for each record.

  • Each record must include listkey and emailids, a comma-separated string of up to 10 email addresses.
  • Side effect: Zoho Campaigns can send each added contact an opt-in confirmation email.
  • Vendor reference: Zoho Campaigns API: Add contacts existing list.

Update List Details

This endpoint template renames a mailing list and sets its sign-up form type.

  • Each record must include listkey, newlistname, and signupform (public or private). All three are mandatory.
  • Vendor reference: Zoho Campaigns API: Update list.

Delete Mailing List

This endpoint template deletes a mailing list.

  • Each record must include listkey and deletecontacts (on or off).
  • Side effect: the list is permanently deleted. With deletecontacts set to on, its contacts are also deleted from the organization.
  • Vendor reference: Zoho Campaigns API: Delete list.

Move Contact to Do-Not-Mail

This endpoint template adds a contact to the organization's Do-Not-Mail registry.

  • Each record must include contactinfo, a JSON string such as {"Contact Email":"jane@example.com"}.
  • Side effect: Zoho Campaigns sends no further emails to the contact.
  • Vendor reference: Zoho Campaigns API: Do not mail.

Create Tag

This endpoint template creates a contact tag. This template sends a GET request with the tag name in the URL.

  • Each record must include tagName. The template passes only the tag name to Zoho; set a description or color in Zoho Campaigns if you need one.
  • The tag name is placed in the request URL, so it must be URL-safe: avoid spaces and characters such as &, #, ?, and +.
  • Vendor reference: Zoho Campaigns API: Create tag.

Associate Tag with Contact

This endpoint template applies an existing tag to an existing contact. This template sends a GET request with the tag name and email address in the URL.

  • Each record must include tagName and lead_email.
  • Both values are placed in the request URL, so they must be URL-safe: avoid spaces and characters such as &, #, ?, and + (including + in email addresses).
  • Vendor reference: Zoho Campaigns API: Associate tag.

Remove Tag from Contact

This endpoint template removes a tag from a contact. This template sends a GET request with the tag name and email address in the URL.

  • Each record must include tagName and lead_email.
  • Both values are placed in the request URL, so they must be URL-safe: avoid spaces and characters such as &, #, ?, and + (including + in email addresses).
  • Vendor reference: Zoho Campaigns API: Deassociate tag.

Delete Tag

This endpoint template deletes a tag. This template sends a GET request with the tag name in the URL.

  • Each record must include tagName. The tag name is placed in the request URL, so it must be URL-safe.
  • Side effect: the tag is permanently deleted and removed from every contact.
  • Vendor reference: Zoho Campaigns API: Delete tag.

Create Draft Campaign

This endpoint template creates a draft campaign. It does not send or schedule the campaign.

  • Each record must include campaignname, from_email, subject, and list_details, a JSON string that maps list keys to segment IDs, for example {"<listkey>":[]}. from_name, content_url, and topicId are optional.
  • Vendor reference: Zoho Campaigns API: Create campaign.

Clone Campaign

This endpoint template copies an existing campaign into a new draft.

  • Each record must include campaigninfo, a JSON string with oldcampaignkey (the campaign to copy) and the new campaign's campaignname, subject, from_name, from_add, and reply_to.
  • Vendor reference: Zoho Campaigns API: Clone campaign.

Delete Campaign

This endpoint template deletes a campaign.

  • Each record must include campaignkey. Use the List Recent Campaigns source template to find it.
  • Side effect: the campaign and its reports are permanently deleted.
  • Vendor reference: Zoho Campaigns API: Delete campaign.

Create Custom Field

This endpoint template creates a custom contact field.

  • Each record must include fieldname and fieldtype (for example Text, Integer, Phone, Date, Picklist, Email, Checkbox, LongInteger, URL, or textarea). fieldlength is optional for types that accept it.
  • Vendor reference: Zoho Campaigns API: Create custom field.

Create Merge Tag

This endpoint template creates a custom merge tag for use in campaign content.

  • Each record includes mergename, fieldname, tagtype (custom), fieldtype, mailval, and socialval. See the vendor reference for which fields each merge tag type needs.
  • Vendor reference: Zoho Campaigns API: Merge tags.

Create Topic

This endpoint template creates a topic.

  • Each record must include details, a string such as {topic_name:News,topic_desc:Weekly news}. For a brand-product topic, add product_id inside details; use the List Products source template to find it.
  • Vendor reference: Zoho Campaigns API: Create topics.

Mark Coupon Used

This endpoint template marks a coupon as used.

Manual configuration​

Zoho Campaigns destinations can also be manually configured to send data to any valid Zoho Campaigns API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Zoho Campaigns endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Zoho Campaigns endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.