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







                            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

                                                                                                              • Weekly Tips : Master Keyboard Shortcuts in Zoho Mail

                                                                                                                If you spend a lot of time managing emails, switching between your mouse and keyboard can slow you down. Whether you are replying to clients, organizing your inbox, or searching for messages, every second counts. So, how can you streamline your email
                                                                                                              • Introducing custom lookup fields in the Tickets, Contacts, and Accounts modules

                                                                                                                Hello all, We are excited to announce a new enhancement that will empower you to further customize the Tickets, Contacts, and Accounts modules. Now, you will be able to create custom lookup fields in your Tickets, Contacts, and Accounts layouts for more
                                                                                                              • DKIM cannot be enabled for the domain as no verified default selector present

                                                                                                                Can't get the DKIM working. May you please check my account (nksy.us) to see what's wrong?
                                                                                                              • Collections Management: #3 Tackling Payment Failures

                                                                                                                Sam refreshed the dashboard. "Payment failed". Same customer. Same subscription. This is happening for the third time. He sends a usual email: "Your renewal payment failed again. Could you please check and retry?" A couple of days passed, and there was
                                                                                                              • How do I increase the email attachment size in Zoho CRM ?

                                                                                                                It looks like I'm limited to 10MB when sending an attachment using the email widget on a record in Zoho CRM. Is there a way to increase the size? Or can I use some other tool? From what I'm reading online, I'm maxed out at 10MB. Any insight would be greatly
                                                                                                              • WhatsApp Channels in Zoho Campaigns

                                                                                                                Now that Meta has opened WhatsApp Channels globally, will you add it to Zoho Campaigns? It's another top channel for marketing communications as email and SMS. Thanks.
                                                                                                              • Zoho sign and creator error message {"code":9043,"error_param":"Checked by","message":"Extra key found","status":"failure"}

                                                                                                                Good day, I receive the error message: {"code":9043,"error_param":"Checked by","message":"Extra key found","status":"failure"} when running below code from creator to sign, void TestForSign(int ID) { //Fetch Template Details (Optional, for dynamic mapping)
                                                                                                              • Download a writer template as .docx instead of .pdf.

                                                                                                                I have been trying to implement a feature to download a writer template as a .docx and got it working partly but it isn't good. Earlier I checked our code and I saw openurl("https://crm.zoho.com/crm/org121314/specific/Template.do?action=print&step=pdfPreview&id="
                                                                                                              • Allow the usage of Multi-Select fields as the primary field on "Layout Rules"

                                                                                                                We want to force our users to enter some explanation strings when a multi-select field has been utilized. I can't understand the reason for the usage restriction of Multi-Select fields as a primary field. This is a simple "Display hidden mandatory field
                                                                                                              • Extract Archived Projects using Zoho Projects API

                                                                                                                In my organization we archive the projects when they are already completed, charged, invoiced, so that only those that are still pending process remain active. I need to access all projects (active and archived) from an external system, but the API v3
                                                                                                              • Ask the Experts: Five-hour live Q&A session with Zoho WorkDrive product experts

                                                                                                                Have questions about WorkDrive 5.0? Let’s talk! We recently launched Zoho WorkDrive 5.0, packed with powerful updates to help your team work smarter, stay secure, and get more value from your business content. From content-centric workflows and AI-powered
                                                                                                              • File upload support for subforms

                                                                                                                Dear All, Subforms help you add and track data related to your CRM records. We've always supported most of the commonly used field types in subforms, so as to cater to your business requirements. Now we're happy to extend support to file upload fields.
                                                                                                              • Circular record relationship in CRM

                                                                                                                Given there is a lookup in custom module Transactions creating a related list on the chosen Contact record. I. e. a lookup field on Transactions module points to Contacts. The related list on a Contact record can thus have have many transaction records.
                                                                                                              • Is it possible to pull the Zoho desk data into Zoho analytics in real time

                                                                                                                Hi - I am looking to add more dashboards and reports of Zoho Desk in analytics. I see there is a schedule to pull the data into analytics, but I'm wondering if there is an option to pull the data in real time instead of a specific interval?
                                                                                                              • How to set value of dropdown field to variable

                                                                                                                For the life of me, I can't figure out why the following code won't set input.status to the previousSelection. Steps to reproduce: 1. Click input.complete 2. input.status dropdown updates from '1-Backlog' to '4-Done' 3. Click input.complete again to deselect
                                                                                                              • [Product Update] TimeSheets module is now renamed as Time Logs in Zoho Projects.

                                                                                                                Dear Zoho Analytics customers, As part of the ongoing enhancements in Zoho Projects, the Timesheets module has been renamed to Time Logs. However, the module name will continue to be displayed as Timesheets in Zoho Analytics until the relevant APIs are
                                                                                                              • [WEBINAR][MEA] Learn how to control your inventory and multi-channel sales with the Zoho Inventory & Zoho Books integration

                                                                                                                Hello there, We are hosting an exclusive live webinar tailored for businesses across the Middle East and African countries, where you'll learn how to take full control of your inventory and multi-channel sales while keeping your accounting perfectly in
                                                                                                              • Less clicks, more connection – the usability edge of Zoho Desk

                                                                                                                Imagine joining a new workplace, eager to prove your skills, partner with peers, learn new tools, and build a strong foundation for your career. The standards you've set could drive pressure into your head. You now discover the organization is using Zoho
                                                                                                              • Tip #3 Automating total item weight calculation for your sales orders in Zoho Inventory

                                                                                                                Hello, Hope the day is treating you well. Last week, we saw how we could automate the calculation of total shipping charges from numerous shipments for your sales orders and invoices. This week, we will see how you can automate the calculation of total item weight for your sales orders.  How does this work? First, you are required to capture the weight of all your items using a custom field. And when you create a sales order, you can either have the system display the individual weights for you or
                                                                                                              • Why Format section gets disabled when we create Merge Template over PDF

                                                                                                                I need some assistance I have a Client who is going to give certificates to users who passes his exam. So, I am using mail merge but in ZOHO writer after I upload the PDF and create merge Template over PDF the format Section gets disabled. My problem
                                                                                                              • Whatsapp Integration on Zoho Campaign

                                                                                                                Team: Can the messages from Zoho Campaign delivered through Whatsapp... now customers no longer are active on email, but the entire campaign module is email based.... when will it be available on whatsapp.... are there any thirdparty providers who can
                                                                                                              • How to calculate separate totals for Product Line Items filtered by category in Quotes?

                                                                                                                Hello! I'm working with Quotes in Zoho CRM and need help calculating conditional totals for line items. Current setup: I have two tables in my Quote template (Zoho Writer), both displaying Quoted Line Items Table 1 (top): Shows all products where Product
                                                                                                              • Zoho Desk API Documentation missing a required field

                                                                                                                We are trying to create a section using this information. Even after preparing everything based on that page, we still get an error. The error we get is this: {"errorCode":"INVALID_DATA","message":"The data is invalid due to validation restrictions","errors":[{"fieldName":"/translations","errorType":"missing","errorMessage":""}]}
                                                                                                              • Fetch Subform values through a lookup of a lookup

                                                                                                                Hi, I'm having an issue fetching the values of a subform through a lookup field through another lookup field. The code works perfectly to show me the subform row ID, but the second I try to get any readable data, it says "Error occurred. Please contact
                                                                                                              • Turn Decision Box to a button

                                                                                                                Dear all, I need your help on CSS to turn a Decision Box to a Button. I have a Decision Box like: Turn on/off to refresh the information. (on User Input, either True or False, will refresh the information) Now I want to simulate to treat it like a Refresh
                                                                                                              • Emails not being received from a particular domain

                                                                                                                Cannot receive any emails sent from atco.com Domain is in the spam whitelist so should be no reason for it not to be coming through. Have filed a ticket and besides a generic response of we are looking at it - it seems there is no actual support workers
                                                                                                              • Stock Count

                                                                                                                The stock count is a nice new feature, but we cannot figure out how to: 1. Use it without assigning to a person, we have a team or one of multiple do stock counts as do most any company. 2. Add any extra fields to what the "counter" sees. The most important
                                                                                                              • Send Whatsapp message from Whatsapp template with custom variables

                                                                                                                Hi, I'm trying to do some basic integration for sending WhatsApp messages from Zoho CRM using Zoho Desk whatsapp templates. When creating new whatsapp template in Zoho Desk we can choose ticket related fields as variables but it's not clear how to use
                                                                                                              • Outgoing blocked: Unusual activity detected.

                                                                                                                I just made payment for my Zohomail Today and have been debited so i will like to be Unblocked because this is what it says (Outgoing blocked: Unusual activity detected) Thank you i await your swift responses
                                                                                                              • Integrating with My Own Application and ZOHO CRM Simultaneously

                                                                                                                I have my own WhatsApp bot that uses my WhatsApp business account. I want to use the same phone number to integrate with ZOHO as well. What is the recommended way to do that? Should I integrate my application with ZOHO, forwarding messages whenever the
                                                                                                              • Account for Cryptocurrency Holdings in Zoho Books/Custom Currencies?

                                                                                                                Hello, I've recently started using Zoho to run my small business and I've really been enjoying all of its features. However, I've been struggling to find a way to account for cryptocurrencies in Zoho Books. My company mines a Cryptocurrency token called
                                                                                                              • Transferring CRM Attachments to Workdrive

                                                                                                                relatedrecords = zoho.crm.getRelatedRecords("Attachments","Conditions",conId); attachid = List(); for each ele in relatedrecords { attachementId = ele.get("id"); attachid.add(attachementId); } for each ele in attachid { counter = 1; downloadFile = invokeurl [ url: "https://www.zohoapis.com/crm/v2/Conditions/" + conId + "/Attachments/" + ele type: GET connection : "work_drive" ]; resp2 = zoho.crm.attachFile("Deals",dealId,downloadFile); resp3 = zoho.workdrive.uploadFile(downloadFile, dealWD, "PlaceHolder"+counter+"",
                                                                                                              • New Customization options in the module builder: Quick Create and Detail view

                                                                                                                Hello everyone, We have introduced two new components to the module builder: Quick create and Detail view. The Quick Create Component It is a mini form used to create a record and associate it to the parent record from a lookup field. For example, if you have a Deals lookup in the Contacts module, then you can associate existing deals or create a deal and associate it with the contact. You can customize this Quick Create form by adding standard as well as custom fields. There is no limit to the number
                                                                                                              • unblock my zoho mail account. outlines@zoho.com

                                                                                                                please unblock my zoho mail account, outlines@zoho.com
                                                                                                              • SMTP email sending problem

                                                                                                                Hello, I've sent emails before, but you haven't responded. Please respond. My work is being disrupted. I can't send emails via SMTP. Initially, there were no problems, but now I'm constantly receiving 550 bounce errors. I can't use the service I paid
                                                                                                              • Mailk got blocked / Inquiry About Email Sending Limits and Upgrade Options

                                                                                                                Dear Zoho Support Team, My name is Kamr Elsayed I created this account to use for applying for vocational training in Germany. As part of this process, I send multiple emails to different companies. However, after sending only 8 emails today, I received
                                                                                                              • Forwarder

                                                                                                                Hi, I tried to add a forwarder from which emails are sent to my main zoho account email . However, it asks me for a code that should be received at the forwarder email, which is still not activated to send to my zoho emial account. So how can I get the
                                                                                                              • No chat option

                                                                                                                Chat option is not supported.
                                                                                                              • Direct “Add to Google Calendar” Option in Zoho Meeting

                                                                                                                Hello Zoho Meeting Team, Hope you are doing well. We would like to request an enhancement related to the “Add to Calendar” functionality in Zoho Meeting. Currently, when we open Zoho Meeting and view our meetings under My Calendar, there is an Add to
                                                                                                              • DKIM cannot be enabled for the domain as no verified default selector present

                                                                                                                Hi Support Team, For Domain DKIM record trying to enable status. but showing error "DKIM cannot be enabled for the domain as no verified default selector present" So, please resolve the issue. Thank you.
                                                                                                              • Next Page