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

      • Is there API Doc for Zoho Survey?

        Hi everyone, Is there API doc for Zoho Survey? Currently evaluating a solution - use case to automate survey administration especially for internal use. But after a brief search, I couldn't find API doc for this. So I thought I should ask here. Than
      • Email Campaigns overview page is missing SENT DATE and # people sent to!

        I would like to see the date the email campaign was sent, so I can understand and track when each email campaign was sent. Right now, unless you go to a contact who received a campaign, you cannot see when the campaign was sent (!!!!!!). So, if my boss
      • SEO recommendation of H1 tag for website tittle

        The exact words are “ It is good practice to place the page title inside the H1tag.” Now I already have one H1 tag on my website but it is not website tittle. In the SEO recommendation that is clear too that I have h1 tag on my page. Now I don’t know
      • How to choose other payment methodes than creditcards

        We have connected stripe as a payment provider in zoho books, booking, commerce and checkout. In stripe we selected al major payment methodes for Belgium (mainly bancontact). However, at checkout customers seems to have only the possibility to pay with
      • Introducing Zia LLM: Zoho’s in-house Generative AI solution for CRM's AI capabilities

        Hello everyone, We're excited to announce the launch of our in-house Large Language Model (LLM) by Zia to power our AI offerings. What is LLM? LLM stands for Large Language Model, a powerful AI technology that processes and generates human-like text based
      • How to call a Creator function which is in a different Creator application?

        How to call a Creator function which is in a different Creator application?
      • Can the code in my "Successful form submission" WF be invoked from a function?

        Can "Successful form submission" be invoked from a function? Data gets into a form manually and programatically. My code in "successful form submission" is good and I want to reuse it/call it, from another function which does Insert Into How to achieve
      • Kaizen #169 - Serialization and Schema Management in Queries

        Hello everyone! Welcome back to another post in the Kaizen series! In Kaizen #166, we discussed handling Variables in Queries and associating the query in Kiosk. This week, we will discuss Serialization and Schema management in Queries. Business Scenario
      • Introducing Keyboard Shortcuts for Zoho CRM

        Dear Customers, We're happy to introduce keyboard shortcuts for Zoho CRM features! Until now, you might have been navigating to modules manually using the mouse, and at times, it could be tedious, especially when you had to search for specific modules
      • Feature Request: Notebooks within notebooks (Tree-like structure)

        Dear Zoho! I already migrated all my stuff from Google Keep, Im really fond of Zoho Notebook so far. One thing that could make the service much more powerful is multi-level notebooks (or tree like structure). For example, entering into Notebook named
      • How to Retrieve and Store Expense Attachments from Zoho Expenses?

        I am currently syncing Zoho Expenses with our internal portal. During the sync process, I can successfully retrieve expense details, including document-related information such as file_name, document_id, and other metadata. My goal is to retrieve these
      • Can't get authorization for Sandbox environment using the self client

        Hello, After creating a self client, and following the client-credentials method (as it's not optimat to manually generate a code for every 10 minutes), after inputting the sandbox org id for SOID parameter, im getting the error: "error": "no_org". For
      • Create landing pages from Zoho Marketing Plus

        Hey everyone, Over the last few months, we've introduced various features and enhancements to bolster the marketing capabilities of Zoho Marketing Plus and make it simpler for everyone. To that end, we're excited to announce that Zoho LandingPage is now
      • How to Download Expense Attachments from Zoho Expenses Using Document Details?

        I am currently working on syncing Zoho Expenses with our internal portal. While syncing, I can successfully retrieve expense details, including document-related information such as file_name, document_id, and other metadata. However, I am facing an issue
      • Custom service report or Zoho forms integration

        Hello, So far the experience with Zoho FSM and the integration with Books has been good, however there are limitations with service reports. As with my business, many organisations send technicians to different types of jobs that call for a different
      • Email tracking subdomain

        The Email Tracking configuration screen of the ZeptoMail asks for a subdomain. I have gone through the documentation but could not find more information about how that subdomain is used by ZeptoMail to track the emails. Can someone throw some light about
      • Chart View group X-axis values above a value

        I have a data set with X values ranging from 0 up to 300-400, the Y values are an AVG of the values for the given X. I am interested in the values at the low end of the scale, say 0-10 and want the X values 10 and greater to be grouped into a single category
      • How do I get the Text Account name instead of the Reference number?

        Good Morning everyone! I am very new to zoho analytics. I'm trying to create some pivot tables and when I add the Account or Division name it comes up as a reference number. From my research, I need to use a lookup. I'm having a really hard time understanding
      • Custom API - Need to create a string return value, not only MAP

        @Support: When creating a Custom API it only allows a return from a function of MAP type. The service I'm using requires a string return, how can this be achieved?
      • missing video-urgent

        hi..I have a problem regarding zoho meeting. I already record almost 2hrs for my interview session. After end my session, i'm stop the recording. Its happened when i didn't received any meeting recording at my email.But i received recording 7minutes after
      • Duplicate New Ticket Emails

        I am getting two Ticket emails when a ticket is created. The first one goes to me as the Admin helpdesk@ And because I am an Agent as well it also send to helpdesk@, support1@ and support2@ Is there any way to stop this?
      • Ticket Response Email Template

        Is there a way to have an email template automatically selected when I click on Reply for a ticket?
      • Unpublishing Job Post for LinkedIn

        Hi, We have experienced issue with the above. We did unpublish a job in Recruit but it still appear under Job section in our LinkedIn page. It did not remove from LinkedIn as it should be.  Please check and advise. Regards, Snyder 
      • Editor limitations to define screen types

        Guys I have noticed that even in version 2.0 of the editor (which is this new one we use) we still have a lot to improve... When I compare to some more global solutions like Wix, Zyro, Go Daddy, Squarespace and Weebly feel that we have some limitations
      • Dúvidas do Zoho Creator

        Pessoal, Estou colocando um tópico para dúvidas do Zoho Creator. Um abraço, Leandro
      • Tropicalize Books

        Books is an incredibly powerful tool that works well in many countries. But I feel that it is a product that is not yet "tropicalized" for Brazil as we speak (this would be like adapting the local reality). We have many strong competitors who do more
      • Automatic Sitemap Generation

        Guys are all right? Doesn't make sense for me to have to generate a map site and upload it... because it's not automatically generated just as it is done in WIX? where the customer doesn’t have to worry about this.
      • SEO improvements with ZIA

        Are you okay? I would like to bring an idea that would be amazing to improve the product that is the possibility of being able to improve the SEO of the pages (this of each page or each article on the blog) through ZIA so that it could create page Summary
      • Automatically updating field(s) of lookup module

        I have a lookup field, which also pulls through the Status field from the linked record. When the lookup is first done, the Status is pulled through - this works perfectly. If that Status is later updated, the lookup field does not update as well. As
      • Initiating a SalesIQ Zobot from a custom button on Zoho Sites

        I have created a Zobot set to initiate on a custom action called "Fast_Answers". On Zoho Sites, I created a code snippet button and set it to on-click run the event called "Fast_Answers". I installed the SalesIQ integration code into the Zoho Sites Page
      • Zoho Desk -> Zoho Analytics : Where is the field for "Layout" ?

        I have many different layouts on my helpdesks and I want to be able to identify the stats for each one, however I can not file the field in the raw data from the Zoho Desk datasource. I thought it might be under "Tickets" but there is nothing. There is
      • Set resolution mandatory field

        Hi,  i have 2 questions:) : - i want to set the resolution field mandatory before close the ticket. Because for now, i can close the ticket without writing how i solve it - how can i setup zoho desk to receive ticket by email(e.g. clients sent email to support@mydomain.com) and it create a ticket in zoho desk
      • Impuesto automatico en cotizaciones

        Buen dia Mi pregunta es como se puede poner alguna operacion para que las cotizaciones me salgan automaticamente con impuestos ya que uno al cargarla al final tienen que añadir el porcentaje de impuesto Saludos
      • Zoho Assist "Agree and Download" Button "Greyed Out" ("Light Blued" Out)

        Anyone else having issue where support clients are unable to click "Agree and Download" to access the client so that we can provide remote support? This is for "on demand" support via accessing the support page and entering the support key and name. This
      • Project Billing with the Staff Hours Method in Zoho Projects

        The Staff Hours Billing Method in Zoho Projects allows you to bill your clients based on the actual time spent by each team member on a project, at the rate set for each user. This is useful for projects where different skill sets are needed and service
      • Creator Subform to CRM Subform

        Hello all, Has anyone successfully written data from a Creator Subform into CRM subform? I have been able to get the rows to populate but none of the data will come through. I'll add my code and the result in CRM. Creator Subform is 'Delivery_Receiving_Hours'.
      • custom fields not populating from deluge script into invoice

        Hello, I've created some Deluge script that is meant to take a few inputted invoice custom fields and calculate a few others. I can see when I execute the function that my inputted custom fields are being passed, yet im still ending up with all "null"
      • tax summation function - getting error

        Hello, I'm trying to create a function that adds all of individual tax rates from a few jurisdictions. I'm getting an error on line 9 - Value is empty and 'get' function cannot be applied. I've checked that I have data in each of the required fields,
      • Backstage / Zoho Books integration

        Hello. We have Zoho One and have slowly started using Backstage. Loving it. Problem is, we have ZERO accounting control over what is sold through this product. When will we be able to connect it to our existing Zoho Books tenant? Thank you very much!
      • Getting list of calendar events over api for zoho mail calendar

        Hi, I am using just Zoho mail without using Zoho CRM. I wanted to get all events booked in my zoho mail calendar through an api at regular intervals. I could find such API support for Zoho CRM calendar but not for zoho mail calendar. Can you kindly let
      • Next Page