Kaizen 141 Zoho CRM's API Collection in Postman

Kaizen 141 Zoho CRM's API Collection in Postman

Hello everyone!
Welcome back to another week of Kaizen!

In today's post, we will discuss:
  1. What is Postman?
  2. Zoho CRM's API Collection in Postman
  3. Where is it available?
  4. Prerequisites for using the collection
  5. Forking the API Collection from Zoho CRM Developer Workspace
  6. Setting up the environment
  7. Registering a Client in Zoho API Console
  8. Generating tokens
  9. Making an API call
  10. A quick alternative to token generation using Guided Auth

1. What is Postman?

  • A popular tool for API development and testing.
  • User-friendly interface for making API requests, viewing responses, and managing different environments.

2. Zoho CRM's API Collection in Postman

  • Boilerplate requests that you can use to test and explore the CRM APIs in various environments for multiple organizations.
  • Makes the process of exploring APIs swift and effortless. It also significantly reduces the risk of errors.

3. Where is it available?

The Zoho CRM API Collection is available in Zoho CRM Developers workspace in Postman.

4. Prerequisites for using the Collection

  • A Zoho CRM account to access the Zoho API Console.
  • A registered client (self-client/web-based) to generate an org-specific grant token.

5. Forking the API Collection from Zoho CRM Developer Workspace

  1. Download and install Postman.
  2. In the Postman app, click the search icon at the top bar and type Zoho CRM Developers. The Zoho CRM Developers Workspace opens.
  3. Click Collections on the left bar.
  4. Click the more actions icon.
  5. Click Create a Fork.
  6. Give a name to your collection, and choose the workspace you want to save it to.
  7. You can select one or more environments to fork and pin to the collection.
  8. Click Fork Collection. Forking will happen in the background.


6. Setting up the environment

An environment is a group of variables that you can reuse in API requests and scripts.
  1. Click Environments on the left bar.
  2. Click Create Environment and give it a name.
  3. Under Variable, add the following variables:
    client-id
    client-secret
    redirect-uri
    authorization-code
    access-token
    refresh-token
    accounts-url
    api-domain
    expiry-time


7. Registering a client in Zoho API Console

For your app to be able to use users' data in Zoho CRM across multiple orgs, you must register your app as a client in Zoho CRM.
In this post, we have used Self Client as the client type. For details about when to choose between a self-client and web-based client, refer to this Kaizen post.
  1. Go to Zoho API Console.
  2. Click Add Client.
  3. Choose Self Client from the list of client types and click Create Now.
  4. You will see the client ID and client secret.


8. Generating the tokens for a self client

Zoho CRM APIs follow the OAuth2.0 protocol for authentication.
This involves three tokens viz, grant token(authorization code), access token and refresh token.
  • Grant token - Also called the authorization code, for a self client, this token is generated in the API console itself. This token informs Zoho's authorization server(Zoho Accounts) that your app wants to access Zoho CRM users' data(bound by scopes). This token is environment-specific, i.e, if you choose a production org while generating this token, you can access Zoho CRM data in the production environment only. This token is valid from 3 minutes to 10 minutes based on what you choose in the console.
  • Access token - After you have authenticated your app and generated a grant token, you must exchange it with Zoho Accounts for an access token. This access token will also have the same scopes as your grant token. This token is valid for one hour. You must send this token in the header of every API call as a bearer token.
  • Refresh token - Since the access token is valid only for an hour, you can use the refresh token to generate a new access token. Instead of creating a grant token again for the same scopes and generating another access token, you can directly use the refresh token and get a new access token with the same scope. Refresh token is valid until you revoke it.
Let's see how to generate these tokens.



Creating the grant token is a one-time process. After you generate access and refresh tokens using the grant token, you can simply use the refresh token to create new access token every hour.

9. Making an API call

Now that we have generated the tokens, let's make an API call using the access token.
  1. Navigate to V6 > REST APIs > Records > Get Records > Accounts.
  2. You can see the request with a few fields already in place.
  3. Modify the parameters as required.
  4. Under Auth, you can see the variable {{access-token}} that holds the access token we generated earlier.
  5. Hit Send to get a response.


10. A quick alternative to token generation using Guided Auth

Postman has introduced a new flow called the Guided Auth. This method allows new users to acquaint themselves with making API calls and testing them, without the hassIe of setting up a client.
In this flow, Zoho acts as the client and takes care of generating the grant and access tokens for a set of pre-defined scopes.
Follow these steps to use Guided Auth.
  1. Click Set Up New Authorization in Postman.
  2. Click Authorize. You will be redirected to Zoho's Login page.
  3. Sign in to your Zoho account.
  4. Choose the org for which you want to generate the token.
  5. Click Agree on the consent screen to grant permission to use your Zoho CRM data as per the scopes on the screen.
In the backend, Zoho generates the grant and access tokens, and you will see the access token in your Postman instance under Auth Credentials.
Note that flow does not give you a refresh token. This method is only to get a head-start with APIs without facing authorization errors. As always, the access token is valid for an hour, after which you have to follow the process of authorizing Zoho to generate another token.



As you can see, when you use our API collection, making API calls to Zoho CRM is a piece of cake as all the requests are already in place with examples.


We hope you found this post useful. We'll meet you next week with another interesting post!
Let us know your feedback in the comment section or write to us at support@zohocrm.com.
Cheers!


    • Recent Topics

    • Possibility of Recording CookieConsent in a Hidden Field in Zoho Forms

      Dear Zoho Forms Team, We are using Zoho Forms on our website and have encountered a technical question related to GDPR compliance. Currently, we have Google Tag Manager installed, along with a script that tracks UTM parameters and GCLID. To comply with
    • Snapshot of totals

      Hi, I'm more familiar with Creator so it's taking me a while to wrap my headaround the CRM. I've been asked to produce a metric that takes a snapshot total of ceratin fields everyday when they meet certain conditions : Total Average Value for example.
    • Bulk change color of selected notes

      When I select several notes, I want to change their color, but there is no such function. I miss it.
    • Notebook does not remember the window size and position

      Hello am using MS store version 3.3.0 It's not a big issue just a bit of annoying. App starts all the time on max size, after resizing, closing and reopening back to same state as the beginning. any way to fix it please?
    • Customize the Date Format based on preference

      Hello Everyone, We have rolled-out a new field called Date Pattern in the user layout under Locale information. Note: If you notice any change in the date format after this roll-out, please select your preferred format from the settings. Previously, the format of the date was automatically set on the basis of the country locale selected by the user. Now, the user will be able to edit the format in which the date is displayed according to their preference.  The Date pattern field has around 40 patterns
    • Simple Deluge Script

      Hi. I'm brand new to functions but I'm trying to create a script to convert a date field in Meetings to a written format. For example, instead of 02/05/2025 8:00AM, I'd like to convert it to Wednesday, February 5, 8:00 AM. My Date field is the API Name
    • Supercharge your operator productivity by leveraging the power of OpenAI in Zoho SalesIQ

      Heads-up: The OpenAI integration is currently available only for users in (US, IN EU, AU and JP region). We will be rolling it out to other regions soon. From complex neuroscience to simple note-taking, AI has seeped through every part of human lives,
    • Digest Janvier - Un résumé de ce qui s'est passé le mois dernier sur Community

      Bonjour chers utilisateurs, Le premier mois de l'année s'est écoulé à toute allure ! Découvrons ensemble comment s'est passé janvier pour Zoho Community France. Dans un monde où l’information a une valeur inestimable, la protection des données sensibles
    • Export Options

      Hi, In calendar, List view, there is an option to show or hide fields, and we export this view daily, and use it to create a Gantt type chart for the days bookings. It would be SUPER helpful (and time saving) to be able to export the Notes and or Custom
    • Zohocliq status change automatic

      Greetings Zoho, So, i've sync my G-mail calender with zohomail, now every event i get from gmail goes thru zohocliq (WHICH is what i wanted) but the thing is that when the event is there  let's say from 11:30 til 12:30PM my current status doesn't change.
    • Solution for setting up header and footer in a template

      Hi all, Emon need for business, I have long searched the forum and also how to put in my quote and my bills a header and a footer. And finally, I have an other working stream elements allowing me to meet my needs ... Given the number of people seeking the same thing as me, I say it might be good to share my discovery. It's simple and easy to implement First, start by adding the beginning of your HTML the following: <style> html {margin: 0;}  body {margin: 0;}  div # printhead { display: block;  position:
    • Enhancements to the formula field in Zoho CRM: Auto-refresh formulas with the "Now" function, stop formula executions based on criteria, and include formulas within formulas

      Dear Customers, We hope you're well! By their nature, modern businesses rely every day on computations, whether it's to calculate the price of a product, assess ROI, evaluate the lifetime value of a customer, or even determine the age of a record. With
    • Workflow rule to assign new case owner sends email to customer from Original owner issue

      I have a workflow rule to assign a manually created case from a sales rep. to a customer service repr to handle. I also have a workflow rule to send an introduction email from the case owner to the customer. The Problem: The email is going out on behalf
    • Kaizen #176 - Optimizing the Use of Record ID Variables in Zoho CRM Queries

      Hello everyone! Welcome to another week of Kaizen! Since the release of Queries, we have covered Handling Query Variables in Zoho CRM, Serialization and Schema Management, and Leveraging the 'crmAPIResponse' object in Queries in previous posts. Today,
    • Validation Rule Not Working for Mandatory Field in Zoho Blueprint

      As a Zoho user, we created a validation rule for a specific field. However, we noticed that when we made the same field mandatory within a Blueprint, the validation rule we defined did not work. When we reported this issue to Zoho Support, they stated
    • Zoho Forms - Shared Forms

      I chose SHARED FORMS and noticed "Enter atleast" needs a space to be correct.
    • Zoho Marketing/SEO Tools

      Longtime Zoho user here and just curious about other users thoughts. We use Zoho apps to run basically our entire business. The only software tools we use outside of Zoho are SEO tools, such as Ahrefs or Ubersuggest. Has anyone else ever wished Zoho offered
    • Is there a way to automatically move a task from a different tasklist to another tasklist when certain criterias are met?

      Hi there, Im new to zoho projects and i was wondering if there was a way to automatically move a task from a tasklist to another tasklist based on criteria such as when the task status is updated to completed and have it move to the tasklist that is named
    • Bigin iOS and macOS app update: Signals

      Hello everyone! In the latest iOS(v1.10.7) and macOS(v1.7.9) versions of the Bigin app, we have brought in support for the Signals section within the Notifications module. Signals notify you about contact touchpoints, such as when a contact opens your
    • Case and Left Join Problem

      I am attempting to find the cost per lead, however they are on different tables. I am using the Case and Left Join Functions to do so. The following Queries are working correctly. These are below: SELECT "Campaign", COUNT("Id") AS 'total_leads' FROM "Deals"
    • Custom Roles & Granular Permission Control in Zoho SalesIQ

      Hello Zoho SalesIQ Team, We appreciate the functionalities offered by Zoho SalesIQ, but we would like to request a crucial enhancement regarding user roles and permissions. Current Issue: At present, Zoho SalesIQ provides fixed roles—Admin, Supervisor,
    • Can Clients have Access to their record Attachments in Client Portal

      Is there a way to have allow clients access to attachments in their client portal? Attachments is currently hidden in the client portal and I cannot find a way to allow client access. Thank you!
    • Create custom rollup summary fields in Zoho CRM

      Hello everyone, In Zoho CRM, rollup summary fields have been essential tools for summarizing data across related records and enabling users to gain quick insights without having to jump across modules. Previously, only predefined summary functions were
    • Why can't I see the delivered Zoho Campaign automation email on Zoho CRM lead record?

      I recently did update the field mapping on our Leads sync services between Zoho CRM and Zoho Campaigns. The end goal is to create tailored email drip campaigns with the use of segments and automation. I understand you can build cadences, email templates,
    • Rollup summary for custom module

      Rollup summary feature was introduced almost a year ago: https://help.zoho.com/portal/en/community/topic/introducing-rollup-summary-in-zoho-crm-public-early-access-2023 It does not support custom modules tough and this post aims to track such feature
    • Function #32: Schedule low stock notifications on a timely basis to specific users of the organization

      Hello everyone and welcome back to our series! For a business that heavily relies on inventory, monitoring the stock levels and getting timely notifications of low stock items will ensure a smooth sail. Zoho Books allows you to always keep a check on
    • Filling responses from one form into another

      My riding club uses Zoho forms for collecting annual memberships as well as for event entries, we need to collect a lot of repeat information (address, phone number, 4 different membership numbers, ect) or have a volunteer cross reference that info for
    • Use of Multi Lookup fields

      Hi, I wondered if anyone could help. I am trying to develop an automation that would send an email to a list of preferred suppliers associated to an account when a booking is created. I assumed this would be done using the multi lookup field, but I can't
    • How to trigger a specific workflow from Deluge?

      Hi all How do I target a specific workflow in my code: updatedeal = zoho.crm.updateRecord("Deals",deal.get("id"),dealmap,{"trigger":{"workflow"}}); I dont want to trigger every workflow assigned to a Deal when its modified. I just want to trigger a specific
    • Change Currency symbol

      I would like to change the way our currency displays when printed on quotes, invoices and purchase orders. Currently, we have Australian Dollars AUD as our Home Currency. The only two symbol choices available for this currency are "AU $" or "AUD". I would
    • Rearrange web - hidden components

      When you have a good number of forms, reports and pages, searching for one among the hidden components to add it to the menu is simply hell. Huge amounts of time are wasted.
    • Client Script | Update - Introducing Subform Events and Actions

      Are you making the most of your subforms in Zoho CRM? Do you wish you could automate subform interactions and enhance user experience effortlessly? What if you had Client APIs and events specifically designed for subforms? We are thrilled to introduce
    • Automation#30: Auto-Update Time Entry to the Nearest 5 Minutes

      Hello Everyone, Time tracking is a feature in Zoho Desk to help businesses stay organized and efficient. For Zylker Techfix, this feature has helped to track the duration of gadget services to generate accurate bills. However, Zylker Techfix faced a unique
    • Nobody answers on my request

      I sent my request last week on Friday (31 Jan 2025 12:56 PM) to Zoho Forms support (support@eu.zohoforms.com), but nobody answered me and today (4 February 2025) it was closed wityhout answer. I sent copy of my message on upgrade@zohocorp.com, sales@eu.zohocorp.com,
    • Which WhatsApp API works seamlessly with Zoho CRM?

      I’m exploring WhatsApp API solutions that integrate seamlessly with Zoho CRM for customer communication, lead nurturing, and automation. I would love to hear insights from those who have successfully implemented WhatsApp within Zoho CRM. My Requirements:
    • 📣📣 Zoho Bookings - Feature Roadmap 2024

      Hi Everyone, Thank you for all the support you have been showing Zoho Bookings. We had a fabulous 2023, with a bunch of new features and over 60K new users. In 2024, our prime focus will be on user experience, and we have a few vital features coming in
    • Custom Field in Zoho Projects pulling into Analytics

      We have a client that we have built our their new business process using Zoho Projects, and we have build a lot of custom fields with their their Projects where they are capturing specific data points that we want to be able to track and pull data, as well as give them some semi-real time dashboards using Analytics. When we setup the Analytics and linked to Projects we pulled in all of the modules, and there is no data point showing for the custom fields within any of the different modules in Analytics. 
    • How to block a WhatsApp user for sending spam

      Is there a way to block those whatsapp users that just come to play and annoy our service, they also spam us. We have a waba service with sales iq
    • Let's Talk Recruit: Everything you need to know about emails

      Emails are a crucial part of recruitment, from reaching out to candidates to keeping clients informed. Zoho Recruit offers a range of email features designed to make communication effortless. In this post, let’s explore how you can configure, send, and
    • [Product Update] Locations module migration in Zoho Books integration with Zoho Analytics

      Dear Customers, As Zoho Books are starting to support an advance version of the Branches/Warehouses module called the Locations module, users who choose to migrate to the Locations module in Zoho Books will also be migrated in Zoho Analytics-Zoho Books
    • Next Page