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!


    Access your files securely from anywhere


            Zoho Developer Community





                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                      • Ask the Experts



                                          Zoho Marketing Automation


                                                  Manage your brands on social media



                                                        Zoho TeamInbox Resources

                                                          Zoho DataPrep Resources



                                                            Zoho CRM Plus Resources

                                                              Zoho Books Resources


                                                                Zoho Subscriptions Resources

                                                                  Zoho Projects Resources


                                                                    Zoho Sprints Resources


                                                                      Qntrl Resources


                                                                        Zoho Creator Resources



                                                                            Zoho CRM Resources

                                                                            • CRM Community Learning Series

                                                                              CRM Community Learning Series


                                                                            • Kaizen

                                                                              Kaizen

                                                                            • Functions

                                                                              Functions

                                                                            • Meetups

                                                                              Meetups

                                                                            • Kbase

                                                                              Kbase

                                                                            • Resources

                                                                              Resources

                                                                            • Digest

                                                                              Digest

                                                                            • CRM Marketplace

                                                                              CRM Marketplace

                                                                            • MVP Corner

                                                                              MVP Corner





                                                                                Design. Discuss. Deliver.

                                                                                Create visually engaging stories with Zoho Show.

                                                                                Get Started Now


                                                                                  Zoho Show Resources


                                                                                    Zoho Writer Writer

                                                                                    Get Started. Write Away!

                                                                                    Writer is a powerful online word processor, designed for collaborative work.

                                                                                      Zoho CRM コンテンツ






                                                                                        Nederlandse Hulpbronnen


                                                                                            ご検討中の方





                                                                                                  • Recent Topics

                                                                                                  • info, hr, support, ... etc.

                                                                                                    Hello, I want to have a dedicated inbox email as info@mydomain.com, hr@mydomain.com, support@mydomain.com ... etc. , and be able to use these email inboxes inside Zoho applications like using the info with my CRM Email configuration, the email used for
                                                                                                  • How to add curly quotation marks and apostrophes in Zoho Mail

                                                                                                    Is there a way to set up Zoho Mail so that, when I compose email messages, my quotation marks and apostrophes are curly rather than straight? I read a couple of 12-year-old conversations about this topic but specific to Zoho Writer and there was no
                                                                                                  • Import Woocommerce Orders to Zoho Books with Zoho Flow

                                                                                                    Hi folks, is it possible to import Woocommerce orders to Zoho Books using Zoho flow? Usually the Woocommerce Orders have several line which would need to be imported. When I click on "use this flow" it will have me sign in, which is fine, and then I am
                                                                                                  • Zoho task approaching due date notification on Cliq.

                                                                                                    Hello, Currently is possible to set reminders on each task to send an email to the task owner on x days before the due date. I'd like to propose a configuration that you can set in a way that sends cliq messages to the task owner when the due date of an task is approaching (like 3, 5, 7 days before, it's supposed to be configurable). Would be nice to have this kind of notification. I've integrated my Projects with Cliq Extension and it does not have this function (as far as I know) Does somebody
                                                                                                  • How to restrict on duty Requests?

                                                                                                    We need to restrict on duty requests for our employees, for example Work from Home limited to max 16 hours per week, or client visit limited to max 2 days per week How can we do that?
                                                                                                  • Change default "Sort by"

                                                                                                    Is there a way to change the default "sort by" when searching across modules?" in Zoho CRM? Currently the default sort method is "Modified time" but i would like to utilize the second option of "relevance" as the sort by default and not have to change
                                                                                                  • Marking a Desk ticket as Unread after merge

                                                                                                    We have a custom script that runs against every new ticket and auto-merges it with any existing ticket that matches our criteria. That works fine but there is no functionality that reverts the newly-updated ticket back to an "unread" state. I found the
                                                                                                  • Addition of RE: to Every Reply Email

                                                                                                    Hi, In Zoho mail every time I reply to an email it puts a RE: in the subject line. So after a few replies on same email the subject line looks like RE: RE: RE: RE:RE: RE: RE: Order Details Can I stop Zoho mail from doing this bug? Thanks, Grant
                                                                                                  • Operation not permitted

                                                                                                    I'm trying to set up email for this site - pawsathome.uk - and when I go to: Admin Console>Domains>Add> I keep getting error - 'Operation not permitted' - See attachment. WHY??
                                                                                                  • User Filter for Dynamic Date Dimensions in Zoho Analytics

                                                                                                    One challenge I frequently encounter is the need to create multiple versions of the same report—one for yearly data, another for quarterly data, another for monthly, and so on. While this works, it leads to unnecessary duplication, making maintenance
                                                                                                  • In this zoho email option ₹700 /user /year what is the storage space provided?

                                                                                                    In this zoho email option ₹700 /user /year what is the storage space provided?
                                                                                                  • Making another calendar your default calendar

                                                                                                    I am trying to make another calendar my default calendar when I add events to it. It keep going to a single calendar, I need it to go to my google calendar by default, as this is linked to other services / websites. I cannot find an option to make it
                                                                                                  • Zoho Mail Setup for New Domain ModZbig.com

                                                                                                    Respected Zoho Support Community, I have this account as my personal account, I bought a new domain https://modzbig.com/ and I need to know can I setup free Email Setup with this account for my new domain. My new website is about to provide latest mod
                                                                                                  • Displaying Inactive Customers & Vendors

                                                                                                    Can we please have this choice in general settings, it's a pain showing hundreds of inactive records. A simple search clears the "Active records" filter ! A simple message showing "Inactive records match your search criteria but have been omitted, would
                                                                                                  • Consigo excluir um e-mail que enviei errado?

                                                                                                    Olá, enviei um email para um cliente e escrevi coisas erradas, como posso excluir este email enviado da caixa do cliente? existe essa possibilidade de cancelar e-mails que foram enviados? Obrigada
                                                                                                  • Unable to send message;Reason:553

                                                                                                    Can Receive email, but Not sending. Please check & let me know the possible solution.  zb14340497 Thanks
                                                                                                  • Font Size 11 - Zoho CRM Email Templates

                                                                                                    Our company communicates with our vendors exclusively using Calibri Font Size 11, as this is the standard formatting for professional emails. Since the CRM only allows for the selection of font sizes 10 & 12, we have been unable to utilize the CRM email
                                                                                                  • Adding Attachment to Desk Ticket via Deluge

                                                                                                    Hello, My team has a process where some people are entering information into a workbook in Zoho Sheet, and we need to get a copy of workbook into a ticket in Desk. We currently have a 'Submit' button on the Sheet that triggers a webhook to Flow, and from
                                                                                                  • Set Custom Icon for Custom Modules in new Zoho CRM UI

                                                                                                  • Power-up your app with spreadsheet editing using Zoho Office Integrator!

                                                                                                    Hello users, Did you know that you can create and edit spreadsheets right in your web app? With Zoho Office Integrator's embeddable spreadsheet editors, you can easily add the capability to create and edit spreadsheets collaboratively in your app. With
                                                                                                  • Lead Blueprint transition in custom list view

                                                                                                    Hi, Is It possible to insert the Blueprint transition label in a custom Canvas list view? I am using Lead module. I see the status, but it would be great if our users could execute the Blueprint right from the list view without having to enter the detailed
                                                                                                  • Time Based Workflow Rules for Projects and Tasks

                                                                                                    Project managers spend a significant amount of time manually monitoring task deadlines, notifications, and follow ups. Zoho projects' Workflow Rules help automate these repetitive processes and save valuable time. Workflow rules are a set of actions that
                                                                                                  • How to Send Weekly Scheduled Emails of a Custom View

                                                                                                    Greetings, We have a custom view called "All Employee View" for the Employee form. We are able to manually export that view using the "Export" button: However, we want to programmatically export this view as an XLS file each week and send it in an email
                                                                                                  • Extract first and last name

                                                                                                    I am trying to build a custom function in Flow, when a new Zoho Booking is added I want to split the Name field into first last name. I understand the function needs to be a string and this works but I am unsure how to write this in the flow script. result
                                                                                                  • Field value permission to set for automation to work as expected?

                                                                                                    I would like confirmation on the CRM software behaviour with the following configuration. A while ago I had discovered the solution by trial-and-error and now I don't remember what the conclusion was. I have a picklist field in the layout that I only
                                                                                                  • SEO for your Zoho Sites Website

                                                                                                    Join our live webinar to learn how to use Zoho Sites' SEO tools to boost your website's ranking. Our product specialist will demonstrate everything you need to know about optimizing your web pages to make them search engine friendly. Register here for free: https://www.zoho.com/sites/webinars/
                                                                                                  • Convert Leads to Deals in Portals?

                                                                                                    Is there a way to convert leads to deals, like the main program does? It doesn't seem to do it in portals. It seems a bit pointless having it.
                                                                                                  • Default view in Email on Company Module

                                                                                                    Is there a way to default the view on the COMPANY module to be "Emails Associated with the Related Contact" it is extremely frustrating to have to swap it every time. This is fairly new - it used to have it defaulted differently
                                                                                                  • Custom module in Portals won't edit

                                                                                                    I have a custom module but Portals access users can't edit it. They can create and delete though. In the Portals settings I have Create, Edit and Delete set turned on. Anyone know what this could be?
                                                                                                  • Kaizen #111 : Set default values based on Page Layouts using Client Script

                                                                                                    Hello everyone! Welcome back to another interesting Kaizen post. In this post, let us discuss how to set default values for fields based on different layouts using Client Script. In this Kaizen post, What are Page Layouts? Client Script is specific for
                                                                                                  • YET ANOTHER BUG: Client Script Flyouts no longer acting like Flyouts

                                                                                                    As per https://help.zoho.com/portal/en/community/topic/kaizen-157-flyouts-in-client-script one of the key benefits of a Flyout over a Popup is the ability to move it around the page. This no longer works. The "width" and "height" configuration settings
                                                                                                  • Does Client Script work on Zoho CRM Portal?

                                                                                                    Hi ! I create a new module to use at customer portal. But Client Script looks not work. Please help me clarify, thank you!
                                                                                                  • Translation in Zoho CRM now supports various regional languages

                                                                                                    Release status (Last modified on January 2, 2025): This feature is currently available for all users in enterprise and above editions, across all data centers. Hello everyone, Imagine a multinational company with teams spread across various regions, each
                                                                                                  • Drop down of Zoho users aka Employees

                                                                                                    Is there any field I can add to have an up-to-date list of current Zoho users ? Use case is for an employee to select their manager - however I don't want to have to manually populate a dropdown field every time someone joins or leaves our company. Why
                                                                                                  • Add multiple users to a task

                                                                                                    When I´m assigning a task it is almost always related to more than one person. Practical situation: When a client request some improvement the related department opens the task with the situation and people related to it as the client itself, the salesman
                                                                                                  • Last Name / First Name

                                                                                                    Hello , My company adds contacts on a "Last Name , First Name" basis. We've noticed that when viewing accounts there is no " , " (comma). It's VERY misleading. I have set the custom view to show "last name" "first name" instead it joins them both and
                                                                                                  • Launching CPQ for Zoho CRM! An in-built solution for bespoke quote management

                                                                                                    Hello everyone, We are thrilled to announce the public release of CPQ (Configure, Price, Quote) for Zoho CRM, which is a fundamental block in sales management. NOTE: CPQ was a public early access feature from March 2023 — January 2024. Since February
                                                                                                  • Unable to receive emails on outlook

                                                                                                    I am able to send on outlook, but unable to receive. None of the settings have been changed and it was working perfectly up until a few days ago.
                                                                                                  • Zoho Creator User Group meetups in a city near you!

                                                                                                    Greetings from the Zoho Creator team! We're excited to announce that we're hosting a series of Zoho Creator meetups in various cities across Australia and New Zealand. We invite you to join us for an exciting day of learning and fun. Our meetups are a
                                                                                                  • How to view shared mailbox in Outlook

                                                                                                    How to view shared mailbox in Outlook or in another software
                                                                                                  • Next Page