Introducing Zoho Creator's v2 APIs

Introducing Zoho Creator's v2 APIs

Hello App Creators,

Welcome to Zoho Creator's v2 APIs! This post will serve as the central point for migrating implementations of Creator's current APIs (v1) to v2.

Improvements that v2 brings

  • OAuth-based authentication, which is more secure than the authtokens
  • Support for the PATCH and DELETE methods
  • Better structuring of the API request: form data is to be added to the request’s body in the JSON format
  • Better error handling resulting from a more insightful set of error codes and messages
  • Better performance in comparison to the current version (v1)
  • No keyword restrictions

Documentation


Other things to know

  • v2 APIs accept only JSON inputs, and return the response in the JSON format
  • The request rate is the same for v2 APIs as well — 50 requests per minute per API endpoint per IP address
  • Unlike v1, there's no limit to the response size in v2. However, v2 APIs can process a maximum of 200 records per request.
  • The Get Record - Detail View API will not fetch the records displayed in the related data blocks (if any)
  • For Creator 5 accounts, the view records API (v1) fetches data from the fields that are displayed in the quick view and detail view. The corresponding v2 APIs are view-specific: Get Record - Detail View and Get Records - Quick View.

Migration to v2

Zoho Creator’s v1 APIs will reach their end-of-life on 3rd February, 2021. Thus we recommend that you use our v2 APIs for upcoming implementations and start migrating your v1 implementations as soon as possible.

To migrate your v1 implementations to v2, in short:
  1. Revisit the reasons for which you used our v1 APIs.
  2. Identify the scopes you'll require for those operations.
  3. Register the client applications that are to use the Creator APIs, by creating client credentials for them.
  4. Generate access and refresh tokens.
  5. Set up connections from your applications to Zoho Creator using the corresponding client credentials, scopes, and access tokens.

Going forward

We’ll be provisioning the following in the near future — we’ll keep you all posted.
  • Adding the Creator scopes to the Zoho OAuth connection - DONE - about the scopes
  • v2 API-based Deluge tasks to integrate with Zoho Creator - DONE - Help Documents
  • Bulk APIs — APIs that will allow you to process records beyond the 200 limit

- - - - - - - -

Let us know your thoughts in the comments below.

Best,
Lakshman | Zoho Creator Team


    • Sticky Posts

    • Zoho Creator - 2023 Release Projection 1

      Hello everyone! A very Happy New Year to you and your family. Hope you're all good and having a great time using Zoho Creator to make your lives easier and your businesses prosper. 2022 was an action-packed year for us at Creator, and we hope to continue
    • Zoho Creator User Group meetups in a city near you! - Oct - Nov, 2023

      Greetings from the Zoho Creator team! We're hosting a series of Zoho Creator meetups in various cities across the globe, and we'd love to meet you there! Our meetups are a great opportunity to network with industry peers, exchange ideas and best practices,
    • Zoho Creator - 2023 Release Projection 2

      Hello everyone! Time truly flies when you're having an incredible journey, and today we mark the completion of an eventful and action-packed six months. It feels like just yesterday when we embarked on this adventure together with the launch of our new
    • Upcoming Updates - August 2022

      Hi all, Greetings from the Zoho Creator team! Today we've got news for you on some exciting updates. And rest assured— there’s more to come! In this post, we'll be going over the upcoming features and improvements for this month as mentioned below. A
    • Introducing Zoho Creator's v2 APIs

      Hello App Creators, Welcome to Zoho Creator's v2 APIs! This post will serve as the central point for migrating implementations of Creator's current APIs (v1) to v2. Improvements that v2 brings OAuth-based authentication, which is more secure than the
      • Recent Topics

      • Comment Reactions like a Thumbs Up

        Can we please have the ability to emoji react on comments or at the very least, thumbs a comment up? Literally every other project management system out there can support this and it is very much needed to just acknowledge a comment instead of completely
      • How can I format numbers in an html table?

        I am building an html table to display how much people have paid, but the numbers are losing their formatting: application_table = application_table + "<td style='text-align: right;'>" + payment_row.Amount_Local + "</td>"; Amount_Local is a decimal field,
      • Zoho connect manuals and workflows

        Is there any plans to allow workflows to be triggered from changes or edits to a manual? It would get us over the line for deployment if there was.
      • Introducing Screening Bot for pre-screening automation

        We’ve transformed the chatbot experience in Zoho Recruit! What was once a general Chatbot for sourcing is now a streamlined system with dedicated tools. The original chatbot has evolved into the Sourcing Bot, while the newly introduced Screening Bot simplifies
      • Customer Portal Users Metrics

        Hi, Is there any way to know who and when a specific customer portal user accessed? without having to use the metrics page.
      • Notebook stacks

        Hello, Are you planning to implement some kind of notebook grouping, similar to evernote stacks? I know that we can group notes inside of the particular notebook but for a lot of us it is not enough I belive. Sometimes that additional layer for organization
      • Multi Step Parallel Transitions for Blueprints

        We have two processes, that are sequential and can be done simultaneously inside of one module. For example: For order processing, we have to kinds of tasks: tasks that need to be done at the car directly (for example repairs) and tasks where the physical
      • Accessing Attachments in Zoho Recruit Extension for API Integration

        Hi, I am currently developing a Zoho Recruit extension to integrate with a third-party application. As part of this, I need to retrieve the attachment file from the current record and include it in an API request. However, I couldn’t find a relevant Zoho
      • CRM - QR Codes and Bar Codes

        Hi I am using CRM to run my service team - Asset maintenance business We need to move to and generate a QR code for each Asset we look after. And we need Bar code reading for the testing we do. (pre-bar-coded sample bottles are provided by the lab) Does
      • Mails to Deals

        Hi everybody. We are using ZOHO CRM connected to ZOHO Mail and we have a big trouble, which our ZOHO partner is not able to solve. Zoho CRM automatically connects received emails to last edited live Deal of the same Contact. For us this logic is very
      • How to check if the sum of number fields match 100%

        I have 12 fields (12 months) which contain a number. When I sum the fields in a formula field I see the total, but I want to be sure that the total is always 100 (%). How do I validate that, since you can't validate an formula field it seems.
      • 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
      • Introducing our latest privacy enhancement - Hiding email IDs in Zoho Cliq Networks

        Hello everyone, Zoho Cliq Networks offers a powerful collaboration platform that allows businesses to create dedicated digital workspaces for external vendors, partners, or individuals you want to communicate with professionally without adding them to
      • The amount entered is more than the balance due for the selected bills."

        Hi Team i am trying to record payments for vendors using API and getting this error in response as { "code": 28011, "message": "The amount entered is more than the balance due for the selected bills." } JSON is prepared according to Documentation and
      • Custom Icon on zoho Creator APP

        Is is possible to have a company logo as the APP image rather than the Zoho image?  thank you.
      • Can I print a set of record templates as a single pdf?

        I have a record template formatted as a gift certificate. I can email a single gift certificate to each recipient, but I also need to print the whole batch for the organiser, and they won't want 40 separate files. The layout needs to be identical, so
      • 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 Books | Product Updates | January 2025

        Hello users, Now that January is over, here are some exciting updates to make this new year even better. We’re back with new features and enhancements in Zoho Books, including comparing fields as criteria in workflow rules and a custom SMTP integration.
      • Downloading Image from Subform using Deluge (invokeUrl) - Data Mismatch / Connection Issues

        Hi Zoho Community, I'm struggling to download an image from a subform in Zoho Creator using Deluge and then attach it to a Zoho CRM Deal record. I've been working on this for a while, and I'm encountering issues that I believe are related to either data
      • Zoho Creator's 2025 Release Projection 1

        Hello everyone, This is Prakash, senior product manager at Zoho Creator. Today, I'm absolutely thrilled to pull back the curtain and give you a sneak peek at our first release projection of 2025, with an exciting lineup of features set to roll out in
      • is it possible to adjust the date field to show Monday as a first day

        Hi, Is it possible to adjust somewhere the date field, so the first day of the week is Monday (instead of Sunday)? Thank you! Ferenc
      • Zoho Assist no longer works using VPN

        I have been using Zoho assist for a bit longer than a year. I have been using the VPN Private Internet Access for even longer.  For the first year of using Zoho assist I could remote into a pc, turn on a vpn, it would disconnect but then reconnect my
      • Kiosk GetRecords can't compare formulas

        (submitted as a help request by accident - should have been a topic) Scenario: I have an "email domain" formula whose value is "@xyz.com" if the e-mail address is brent@xyz.com . I have the same field in Leads and Contacts. So, theoretically, I should
      • Capture GPS location field

        When using a mobile phone to complete the form, I need to capture the GPS location. When this field going to be available? Same question for taking pictures with mobile phone and capturing that picture automatically. Thanks
      • In what case it's better to use Developer Console? Only for marketplace?

        As I can see from the documentation, the limitations are challenging. No Custom API No Page Variables No Custom Connections.
      • Zoho Sheets working offline

        Hi, I am looking for the ability to work offline in Zoho Sheets, but currently I cannot find the process to complete this. Does someone have any ideas or steps I might have missed? Also does Zoho Sheets have the "Format as Tables" function as is currently
      • Anyone Can help me converting Excel VBA to Zoho Macro?

        The Macro in general is pretty simple, It just opens a Workbook and copys some of data from that Workbook to the one that was initially open. But when I try to use it on Zoho I get this error "Unknown function: GetOpenFilename". If there is any other
      • Creator Simplified #13: Identify the user's device type using system variable

        Hey Creators, Welcome back to this week's post in the Creator Simplified series. For today's post, we will learn how to determine the user's device type using a simple system variable. Identify whether the users are accessing your application via web,
      • Is there any limit on creating stages in pipelines in Bigin

        Thankyou.
      • Office 365 or Outlook?

        Hello I'm just setting up IMAP integration with our CRM for the first time since we changed to using Outlook via a Microsoft 365 account. I have the choice of 'Office 365' or 'Outlook'. Which should I choose? Thanks
      • Can I send Whatsapp template using Deluge function?

        Hi, Can I send Whatsapp template in Business Messaging using Deluge function? I have tried to search the documentation but I can't find it
      • Notebook for watch no longer in Play store.

        I had to reinstall Notebook on my Galaxy Watch 7. Alas: the app is no longer available in the Play store. What now?
      • Workdrive Oauth2 Token Isn't Refreshing

        I have set up oauth for a bunch of zoho apis and have never had a problem with oauth. With workdrive i am using the exact same template i usually use for the other zoho apps and it is not working. All requests will work for the first hour then stops so
      • Resetting auto-number on new year

        Hi everyone! We have an auto-number with prefix "D{YYYY}-", it generates numbers like D2025-1, D2025-2, etc... How can we have it auto-reset at the beginning of the next year, so that it goes to D2026-1? Thanks!
      • Can I trigger workflow rules only on weekend and certain hour?

        I want to trigger a workflow rules on the leads created between saturday 5 pm to sunday 5 pm. can I do that? i have tried to search but I cant find option something like that. is there any workaround to solve this?
      • Client Can't View Ticket

        Hi, I created a ticket for my Client since he had an issue. I added him as a Contact as well. My client got a notification in his email that the ticket has been created. When he went to view the ticket on his desktop, the screen was blank. He then viewed
      • Headers in Subfrom - Zoho CRM

        Currently we cannot add any headers to CRM Subform If we have very large subforms and we want to logically group the rows it becomes really hard to do it Please add a header feature so we can add headers to a subform to logically and visually group different
      • Re-create auth token

        I need to re-create a self-client auth token, with the same scopes (and additional ones) as the current token. Is there a way to view the scopes assigned to the current token to ensure that no scopes are missing when creating the new one?
      • Cant BCC comments

        Whats the reason why we cant bcc to add to comments? We are getting this error:  We are unable to process this email. WHY DID THIS HAPPEN? We suspect the below reasons to be the cause of failure : 1. You might have mis-spelt the email address. 2. You might have added the email address in BCC I used the copy option within the comments to copy the email address. It works fine if I cc, just not bcc.
      • How to disable clone record for a user?

        Hi, I'd like to disable clone records for some of my users in zoho crm. How can I go about doing that? Regards, CRM
      • Next Page