Introducing Bigin API Version 2.0

Introducing Bigin API Version 2.0

Hello all! We're thrilled to announce the release of the highly anticipated Bigin API v2. The newest version of our API brings a bunch of new endpoints, updates, and improvements, and is highly focused on introducing the most commonly requested APIs, such as COQL, Send Mail, Change Owner, and more. Additionally, it enhances existing APIs to ensure better alignment with the product.

What's new?

What's improved?

  • The Search Records API has been enhanced to support all related comparators for date and date-time data types.
  • The Records API has been enhanced to support the retrieval of records from a particular Team Pipeline.
  • The Related Lists API has been enhanced to support the retrieval of records associated with a specific contact from a particular Team Pipeline.

Major changes: What you need to know

  • Renamed the Deals module to Pipelines. This change reflects across the Bigin API, including request URLs, response objects, and scopes.
  • The terminology for Layout has been changed to Pipeline, and what was previously called Pipeline is now Sub-Pipeline in all corresponding request URLs and response objects.
For more detailed explanation of the latest APIs and enhancements, please refer to our What's new page and Changelog guides.

To start exploring the capabilities of Bigin API v2, head over to our updated documentation and check out our detailed API reference.

We would like to inform you that existing Bigin API v1 clients will remain unaffected, as we have ensured backward compatibility support. However, we advise everyone to start the migration process to the new Bigin API v2. We're yet to finalize the deprecation timeline, but until then, we'll keep supporting v1 APIs. After arriving at a retirement date for v1 APIs, we'll post an update here so that you can start migrating your existing integrations/toppings to v2.

But wait, there's more!

API Credits Dashboard

We're also delighted to share our latest feature: API Credits Dashboard. This feature provides details about the number of API calls consumed in a 24-hour window, and offers a clear overview of the total credits available in the organization's account, both used and unused credits, as well as individual user API consumption. See the help doc for more details.

We encourage you to share your feedback and thoughts on the new version. If you have any questions or need assistance, don't hesitate to post them in our dedicated Bigin Developer Community or reach out to us.

What's next!

We're planning to release API endpoints for Team Pipelines, Sub-Pipelines, and Stages soon. Stay tuned for our official announcement!

Thank you!

    Access your files securely from anywhere

        All-in-one knowledge management and training platform for your employees and customers.







                              Zoho Developer Community




                                                    • Desk Community Learning Series


                                                    • Digest


                                                    • Functions


                                                    • Meetups


                                                    • Kbase


                                                    • Resources


                                                    • Glossary


                                                    • Desk Marketplace


                                                    • MVP Corner


                                                    • Word of the Day


                                                    • Ask the Experts





                                                              Manage your brands on social media



                                                                    Zoho TeamInbox 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

                                                                                                Get Started. Write Away!

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

                                                                                                  Zoho CRM コンテンツ




                                                                                                    Nederlandse Hulpbronnen


                                                                                                        ご検討中の方




                                                                                                                • Recent Topics

                                                                                                                • email template

                                                                                                                  How do I create and save an email template
                                                                                                                • Enhancements in Portal User Group creation flow

                                                                                                                  Hello everyone, Before introducing new Portal features, here are some changes to the UI of Portals page to improve the user experience. Some tabs and options have been repositioned so that users can better access the functionalities of the feature. From
                                                                                                                • Always display images from this sender – Is this feature available?

                                                                                                                  In Zoho mail, I had my "Load external images" setting set to "Ask me", and that's fine. That's the setting I prefer. What's not fine though is I always need to tick "Display now" for each email I get, regardless if I've done that multiple times from several
                                                                                                                • Zoho Notebook Sync problem

                                                                                                                  I'm facing a problem with syncing of notebook on android app. It's not syncing. Sometimes it syncs after a day or two.  I created some notes on web notebook but it's not syncing on mobile app. Please help!!!!
                                                                                                                • Cant Save Gauge on Creator Page

                                                                                                                  How to Save Gauge on Creator Page see movie https://vimeo.com/1116410860?share=copy#t=0
                                                                                                                • Apply Advance option not shown in report

                                                                                                                  We are facing an issue in Zoho Expenses. While approving an Expense Report, the "Apply Advance" option is not appearing under the three dots (More Options). Details: Module: Expense Reports Issue: "Apply Advance" option not visible Status of Report: Awaiting
                                                                                                                • Auto Capitalize First Letter of Words

                                                                                                                  Hi I am completely new to ZOHO and am trying to build a database. How can i make it when a address is entered into a form field like this: main st it automatically changes is to show: Main St Thank You
                                                                                                                • Follow-up emails via Workflow Automation not staying in the same thread

                                                                                                                  Dear Zoho Support Team, I am currently using Workflow Automation in Zoho Campaigns to send follow-up emails. In my test case, I noticed the following behavior: All emails in the automation have the same subject line. If the follow-up email is sent within
                                                                                                                • Client Script refuses to set an initial value in Subform field

                                                                                                                  I tried a very simple, 1 line client script to set a default value in a custom subform field when the "Add Row" button is clicked and the user is entering data. It does not work - can someone tell me why? ZDK documentation suggests this should be doable.
                                                                                                                • Help Center IFrame Issue

                                                                                                                  I have had a working Help Center on my website using an iframe for a while. But now for some reason the sign in page gets a refused to connect error. Can someone please help. If I go to the url manually it works correclty
                                                                                                                • Comment Templates

                                                                                                                  Is it possible to add a template option for comments? We have some agents in the process who's responses require a pre-formatted layout. It would be incredibly handy to have a template for them where they can insert the template and then add their responses
                                                                                                                • Shared values: From classroom lessons to teaching moments in customer service

                                                                                                                  While the world observes Teachers’ Day on October 5, in India, we celebrate a month earlier, on September 5, to mark the birth anniversary of Dr. Sarvepalli Radhakrishnan, a great teacher, renowned scholar, educationist, and advocate for empowerment.
                                                                                                                • Create a list of customers who participated in specific Zoho Backstage events and send them an email via Zoho CRM

                                                                                                                  How to create a list of customers who participated in specific Zoho Backstage events and send them an email via Zoho CRM? I was able to do a view in CRM based on customer that registered to an event, but I don't seems to be able to include the filter
                                                                                                                • Zoho Desk blank page

                                                                                                                  1. Click Access zoho desk on https://www.zoho.com/desk/ 2. It redirects to https://desk.zoho.com/agent?action=CreatePortal and the page is blank. Edge browser Version 131.0.2903.112 (Official build) (arm64) on MacOS
                                                                                                                • I hate the new user UI with the bar on the left

                                                                                                                  How can I reverse this?
                                                                                                                • Question regarding import of previous deals...

                                                                                                                  Good afternoon, I'm working on importing some older deal records from an external sheet into the CRM; however, when I manually click "Add New Deal" and enter the pertinent information, the deal isn't appearing when I look at the "Deals" bar on the account's
                                                                                                                • Client Script also planned for Zoho Desk?

                                                                                                                  Hello there, I modified something in Zoho CRM the other day and was amazed at the possibilities offered by the "Client Script" feature in conjunction with the ZDK. You can lock any fields on the screen, edit them, you can react to various events (field
                                                                                                                • One person/cell phone to manage multiple accounts

                                                                                                                  Hi. I have a personal Free account to keep my own domain/emails. Now I need to create a Business account to my company's own domain, but I have only one mobile phone number I use to everything. How do I do to manage this? Can I manage a Free domain and
                                                                                                                • Tracking KPIs, Goals etc in People

                                                                                                                  How are Zoho People users tracking employee targets in People? For example, my marketing assistant has a target of "Collect 10 new customer testimonials every month". I want to record attainment for this target on a monthly basis, then add it to their
                                                                                                                • Zoho Desk: Ticket Owner Agents vs Teams

                                                                                                                  Hi Zoho, We would like to explore the possibility of hiding the ‘Agents’ section within the Ticket Owner dropdown, so that we can fully utilise the ‘Teams’ dropdown when assigning tickets. This request comes from the fact that only certain agents and
                                                                                                                • Can not Use Attachment Button on Android Widget

                                                                                                                  this always pops up when I touch the attach button on android widget. going to settings, there is no storage permission to be enabled. if I open the app, and access the attach feature there, I can access my storage and upload normally.
                                                                                                                • Announcing new features in Trident for Mac (1.24.0)

                                                                                                                  Hello everyone! Trident for macOS (v.1.24.0) is here with interesting features and thoughtful enhancements to redefine the way you plan and manage your calendar events. Here's a quick look at what's new. Create calendar events from emails. In addition
                                                                                                                • Mass Mail Statistics - Number of unsent emails

                                                                                                                  How do I find out which emails were not sent?
                                                                                                                • Est-il possible d'annuler l'envoi d'un mail automatique ?

                                                                                                                  Bonjour, Lorsque je refuse un candidat, il reçois un mail dans les 24h pour l'informer que sa candidature n'est pas retenue. J'ai rejeté un candidat par erreur. Savez-vous s'il possible d'annuler l'envoi de ce mail ? Merci d'avance pour votre aide.
                                                                                                                • embed a form in an email

                                                                                                                  Hello, how to embed a form in an email that populates Zoho CRM cases? I would like to send emails to a selected audience offering something. In the same email the recipients - if interested - instead of replying to can fill in a Zoho CRM form that creates
                                                                                                                • How to add Zoho demo site page designs to my Zoho Sites website

                                                                                                                  Hi, I would like to add the design from the following demo URLs into my current Zoho website. I have already created two new pages on my site, named “Menu2” and “Menu3.” For the “Menu2” page, I want to use the design from this demo: https://naturestjuice-demo.zohosites.com/menu
                                                                                                                • Digest Août - Un résumé de ce qui s'est passé le mois dernier sur Community

                                                                                                                  Bonjour chère communauté ! Voici le résumé tant attendu de tout ce qui a marqué Zoho le mois dernier : contenus utiles, échanges inspirants et moments forts. 🎉 Découvrez Zoho Backstage 3.0 : une version repensée pour offrir encore plus de flexibilité,
                                                                                                                • Kaizen #206 - Answering your Questions | Displaying Related Purchase Orders from Zoho Books in CRM Deals using Queries

                                                                                                                  Hello everyone! We're back with another post in the Kaizen series. We're grateful for the feedback we received from all of you! One of the questions we received was "I would like to see the list of Purchase Orders in Zoho Books for a Deal in CRM." We
                                                                                                                • Add Analytics function for Title case (capitalising each word in a string)

                                                                                                                  At present, you can only capitalise each word in a string in Analytics during data import. It would be really useful to be able to do this with a formula column, but there is no Title Case function.
                                                                                                                • How to conditionally embed an own internal widget with parameters in an html snippet?

                                                                                                                  Hello everyone, I'm trying to create a dynamic view in a page using an HTML snippet. The goal is to display different content based on a URL parameter (input.step). I have successfully managed to conditionally display different forms using the following
                                                                                                                • Sync more than one Workdrive

                                                                                                                  Hello Please I'm facing some difficulties since some days. In my company we have many zoho accounts in different organisations. And I have to find a way to sync all these Workdrives. I spend many hours to search it on zoho Workdrive but no solution. Could someone help me ? Any idea how I can achieve it ? Thanks in advance. Regards
                                                                                                                • Zoho Flow Customer Support

                                                                                                                  Zoho Flow is refusing to even respond to my support requests. Is there anyone on this forum who knows how to solve Zoho Flow issues? I have a simple problem and need help. Thanks.
                                                                                                                • Base Currency Adjustment Reversal

                                                                                                                  Two questions surrounding the base currency adjustments (BCA). I recently ported over from QB so I need to enter the base currency adjustments. In QB, it will calculate the BCA for you at the end of the year and then reverse it at the top of the following year. Makes sense. Does Zohobooks not do this as well? I created a BCA for Dec 31, 2016 but no reversing entry was made Jan 1, 2017. Am I supposed to manually do a reversal? I'm not even allowed to post journals directly to the 'exchange gain loss'
                                                                                                                • Please implement UAE Central Bank FX rates

                                                                                                                  Hello, as I understand from your knowledge base, any UAE business account created from September 15, 2018 does not have foreign exchange rates fetched automatically. This is a serious inconvenience and I am not sure why ZOHO has not looked into the ways
                                                                                                                • Search Records returning different values than actually present

                                                                                                                  Hey! I have this following line in my deluge script: accountSearch = zoho.crm.searchRecords("Accounts","(RS_Enroll_ID:equals:" + rsid + ")",1,200,{"cvid":864868001088693817}); info "Account search size: " + accountSearch.size(); listOfAccounts = zoho.crm.searchRecords("Accounts","(RS_Enroll_ID:equals:"
                                                                                                                • Super Admin Access to All Courses and Spaces in Zoho Learn

                                                                                                                  Dear Zoho Learn Team, We hope this message finds you well. We are using Zoho Learn extensively for internal and agent training. While managing our courses and spaces, we encountered a significant limitation regarding admin access and course management.
                                                                                                                • Print checks for owner's draw

                                                                                                                  Hi.  Can I use Zoho check printing for draws to Owner's Equity?  This may be a specific case of the missing Pay expenses via Check feature.  If it's not available, are there plans to add this feature?
                                                                                                                • [New Release 2024] Create and embed custom capabilities across CRM with Kiosk Studio, our latest no-code tool

                                                                                                                  [Update | New series] We've started publishing a series of posts on Kiosk Studio. It's called Kiosk Studio Sessions and you can check out the first one here! [Update | 15 Oct} Session #2 is live! This one will look at how to create a kiosk for your call
                                                                                                                • Revenue Management: #10 Common Mistakes while Recognizing Revenue

                                                                                                                  We are at the end of the series on Revenue Management, covering how different businesses recognise revenue. Even with clear standards like ASC 606 and IFRS 15 in practice, businesses often struggle with the nuances of revenue recognition. Especially growing
                                                                                                                • integarting attachments from crm to creator

                                                                                                                  when i tried to integrate pdf attachments from crm to creator via deluge i am getting this error {"code":2945,"description":"UPLOAD_RULE_NOT_CONFIGURED"} the code i used is attachments = zoho.crm.getRelatedRecords("Attachments","Sales_Orders",203489100020279XXX8);
                                                                                                                • Next Page