Viewing API settings

Viewing API settings

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 MarketingHub's API to integrate our functionalities in their applications. 

With API, you can work upon a list of functionalities such as:

  • Create campaigns and view their details
  • View the campaign reports and get the recipients’ activity
  • Add leads (one at a time) and custom fields to a list (private and public list)
  • Get the leads based on status 
  • Fetch the segment contacts and details
  • Connect with other products to import data or leads

 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.

Prerequisite

You need the Standard Admin role to edit information in this page. 

How do I navigate to the APIs page?

To navigate to the APIs page:

1. From the Navigation toolbar, choose Settings.

2. Select APIs under Developer Space.


API Version 1 - Access tokens

We use the OAuth protocol 2.0, which uses access and refresh tokens for authentication. We provide more advanced and secured API using access tokens. Take a look at our Access token help guide for more details.


 Learn more about API  

Add Callback URL

You can use our Callback URL to receive notifications about new leads and leads that have unsubscribed from a mailing list.
You can use either HTTP or HTTPS for callback messages.  

Specifying a callback URL

The Callback URL directs Zoho MarketingHub 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 CallBack URL, follow the steps below:

1. From the Navigation toolbar, choose Settings.

2. Select APIs under Developer Space.


3. Click on Configure now link.


4. Enter your Callback URL in the required box.

5. Choose a Request type.

6. Click Save.



 

Use cases - callback URL

Zylker Accessories

Anna owns an accessories store. She has items like handbags, shoes, and jewelry. She uses Zoho MarketingHub to gather leads and send campaigns to them. She maintains a separate list for every product like shoes, jewels and handbags. 
She wants to get notifications about unsubscribes from any one of the lists by leads so that she can take up one of the following actions,

  • She can try to increase the leads' interest in her brand by sending campaign emails about other products apart from the one that they've unsubscribed from.
  • If the lead is genuinely not interested in any products, she can move them to the do-not-mail list or reduce campaign frequency to them.

She sets up a callback URL, https://www.zylkerstores.com/unsubscribe and sets it to be notified about all unsubscribes that's happening in her org. Upon analyzing the leads, she can easily identify the suitable action plan for them.

 Greg's Restaurant

Greg owns a chain of restaurants at multiple locations and handles them remotely. He uses Zoho MarketingHub to gather leads and share campaigns about upcoming menu specialties and food fests happening in any of his restaurants. 

Recently, he noticed a decline in interest among his leads. He has also been receiving feedback from some customers regarding service and lack of new, innovative dishes in branches. He wanted to instantly act upon this, so he developed an API that would trigger an SMS about the lead details and the nearest branch of restaurant.

He creates a callback URL,  https://www.gregfood.com/unsubscribe  and sets it so that every time an unsubscribe is recorded into the URL, it will trigger the SMS API he has. Now he can identify the issues in different branches and come up with a strategy for them.



Next steps

To get notified about different actions like subscribes, clicks and opens, configure webhooks.

    • Related Articles

    • Settings

      Make your workspace versatile using the different options available in Zoho Sigma.    Developers Add colleagues to your workspace and enable them to work on multiple extensions in parallel.  How to add a developer  Navigate to the Developers section ...

    • Zoho Recruit API

      Zoho Recruit provides API (Application Programming Interface) for integrating Recruit modules with third-party applications, portals or websites, and to customize as per your needs. With the Zoho Recruit API, you can extract Recruit data in XML ...

    • Configuring Gamescope Settings

      Gamescope runs on trophies and badges. It is important to configure the right trophies and badges before you start a game. Availability Permission Required Users with Module Customization permission in their profile can access this feature. Check ...

    • Configuring Gamescope Settings

      Gamescope runs on trophies and badges. It is important to configure the right trophies and badges before you start a game. Availability Permission Required Users with Module Customization permission in their profile can access this feature. Check ...

    • Configuring Gamescope Settings

      Gamescope runs on trophies and badges. It is important to configure the right trophies and badges before you start a game. Availability Permission Required Users with Module Customization permission in their profile can access this feature. Check ...