How to view and access API features

How to view and access API features

API provides access to different operations of campaign and list management. One of the most useful features is removing the need to log in every single time. Resellers can use Zoho Campaign's API to integrate our functionalities in their applications. 

 In this guide, we'll walk you through all API-related details, such as how to add a ZSC key, generate access tokens, and add a callback URL. 

ZSC Key

You need the Zoho Service Communication Key (ZSC) Key to integrate your Zoho Campaigns account with other services. The ZSC key enables to fetch data from other services like Zoho Creator and import it into Zoho Campaigns.

To generate a ZSC key, 

  1. Click Settings icon on the top-right corner of the screen.   settings icon - top right
  2.  Select  APIs  under Developer Space.
    apis menu
  3. Click  Generate ZSC Key.
    generate zsc key

To regenerate a ZSC key,

  1.  Click Settings icon on the top-right corner of the screen.   settings icon - top right
  2.  Select  APIs  under Developer Space.
  3.  Click  Regenerate Key. 
Note: The current ZSC key becomes invalid when you regenerate a new ZSC key. 

API Authentication Token

API provide access to different operations of campaign and list management. One of the most useful features is removing the need to log in every single time. Resellers can make use of Zoho Campaigns' API to integrate our functionalities in their applications. We suggest that you go through the detailed documentation of  API keys.

With API, you can work upon a list of functionalities such as: 
  1. Create campaigns and view the campaign details.
  2. View the campaign reports and get the recipients’ activity.
  3. Add contacts (one at a time) and custom fields to a list (private and public list)
  4. Get the contacts based on status
  5. Fetch the segment contacts and details. 
    api v1.1
We recommend you to use the latest version API V1.1 

Add Callback URL

You can use our Call Back URL to receive notifications about new contacts and contacts who have unsubscribed from a mailing list.
You can use either HTTP or HTTPS for callback messages. 

Specifying a Call Back URL

The Callback URL directs Zoho Campaigns on where to send email addresses as notifications about new subscribes, unsubscribes, and other details such as first name and last name, using merge tags. To integrate your subscription form, you must specify a callback URL. 

To add Call Back URL, 

  1. Click Settings icon on the top-right corner of the screen.   settings icon - top right
  2. Select  APIs  under Developer Space.
  3. Click on  Configure now  link. 
    configure now link
  4. Enter your Callback URL in the required box.
  5. Choose a Request Type.
    save callback url
  6. Click  Save.