Migrating from Zoho Desk XML/JSON APIs to REST APIs

Migrating from XML/JSON APIs to the New REST APIs

Our new REST APIs provide developers with an enhanced and easier way to access and use the features and functionalities of Zoho Desk. This document lists the REST API equivalents to the old XML/JSON APIs to help you seamlessly migrate to the new APIs. 

Important Changes
Below are the most important changes related to the migration. 

Input and Response Format
The old APIs returned responses in both XML and JSON formats. We have designed the new APIs to return responses only in the JSON format to reduce complexity and ensure ease of use. 

HTTP Methods
The new APIs will use basic HTTP methods, such as GET,  POST, PATCH, and DELETE in API requests.

Authentication
The old APIs used authTokens for authentication. The new REST APIs use the more secure OAuth tokens.

orgId
The old APIs used the portal name in requests to identify the organization in Zoho Desk. In contrast, the new APIs use the orgId parameter. You can obtain the orgId of your organization(s) using the Get all organizations API. 
Both the orgId and Oauth token must be included in the headers of all API requests. 

The following table lists some frequently used XML/JSON APIs and their corresponding REST API equivalents.


Old XML/JSON APIs
REST API Equivalents

/api/(xml|json)/(Requests|Cases|requests|cases)/updaterecords  


/api/(xml|json)/(Contacts|contacts)/updaterecords


/api/(xml|json)/(Accounts|accounts)/updaterecords


/api/(xml|json)/(Tasks|tasks)/updaterecords


/api/(xml|json)/(timeentry|TimeEntry)/updaterecords


/api/(xml|json)/(Contracts|contracts|Contract)/updaterecords


/api/(xml|json)/(Requests|Cases|requests|cases)/addrecords


/api/(xml|json)/(Contacts|contacts)/addrecords


/api/(xml|json)/(Accounts|accounts)/addrecords


/api/(xml|json)/(Tasks|tasks)/addrecords


/api/(xml|json)/(timeentry|TimeEntry)/addrecords


/api/(xml|json)/(Requests|Cases|requests|cases)/getrecords



/api/(xml|json)/(Accounts|accounts)/getrecords


/api/(xml|json)/(Products|products)/getrecords


/api/(xml|json)/(Contracts|contracts|Contract)/getrecords


/api/(xml|json)/(Timeentry|timeentry|TimeEntry)/getrecords


/api/(xml|json)/(Tasks|tasks)/getrecords


/api/(xml|json)/(Solutions|solutions)/getrecords


/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbyid


/api/(xml|json)/(Contacts|contacts)/getrecordsbyid


/api/(xml|json)/(Tasks|tasks)/getrecordsbyid


/api/(xml|json)/(Accounts|accounts)/getrecordsbyid

/api/(xml|json)/(Solutions|solutions)/getrecordsbyid


/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbycustomview 



/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbysearch


/api/(xml|json)/(Contacts|contacts)/getrecordsbysearch


/api/(xml|json)/(Accounts|accounts)/getrecordsbysearch

/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbyowner

/api/(xml|json)/(Requests|Cases|requests|cases)/deleterecords


/api/(xml|json)/(Requests|Cases|requests|cases)/getrequestthreads


/api/(xml|json)/(Requests|Cases|requests|cases)/getattachments


/api/(xml|json)/(Requests|Cases|requests|cases)/getattachmentslist


/api/(xml|json)/(Requests|Cases|requests|cases)/addattachments


/api/(xml|json)/(Requests|Cases|requests|cases)/reply


/api/(xml|json)/(departments|department)/getalldepartments


/api/(xml|json)/(portals|portal)/getportallist


/api/(xml|json)/emails/getfromaddress




      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION





                              Quick Links Workflow Automation Data Collection
                              Web Forms Enterprise Begin Data Collection
                              Interactive Forms Workplace Data Collection App
                              CRM Forms Customer Service Accessible Forms
                              Digital Forms Marketing Forms for Small Business
                              HTML Forms Education Forms for Enterprise
                              Contact Forms E-commerce Forms for any business
                              Lead Generation Forms Healthcare Forms for Startups
                              Wordpress Forms Customer onboarding Order Forms for Small Business
                              No Code Forms Construction RSVP tool for holidays
                              Free Forms Travel
                              Prefill Forms Non-Profit

                              Intake Forms Legal
                              Mobile App
                              Form Designer HR
                              Mobile Forms
                              Card Forms Food Offline Forms
                              Assign Forms Photography
                              Mobile Forms Features
                              Translate Forms Real Estate Kiosk in Mobile Forms
                              Electronic Forms Banking 
                              Notification Emails for Forms Alternatives Security & Compliance
                              Holiday Forms Google Forms alternative  GDPR
                              Form to PDF Jotform alternative HIPAA Forms
                              Email Forms
                              Encrypted Forms
                              Embeddable Forms
                              Secure Forms
                              Drag & drop form builder
                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now




                                                        You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                            Manage your brands on social media


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                Zoho Sheet Resources

                                                                 

                                                                    Zoho Forms Resources


                                                                      Secure your business
                                                                      communication with Zoho Mail


                                                                      Mail on the move with
                                                                      Zoho Mail mobile application

                                                                        Stay on top of your schedule
                                                                        at all times


                                                                        Carry your calendar with you
                                                                        Anytime, anywhere




                                                                              Zoho Sign Resources

                                                                                Sign, Paperless!

                                                                                Sign and send business documents on the go!

                                                                                Get Started Now




                                                                                        Zoho TeamInbox Resources





                                                                                                  Zoho DataPrep Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • Related Articles

                                                                                                                        • Overview of Rest APIs

                                                                                                                          We provide a comprehensive suite of REST APIs to manage your help desk account and the associated data. You can integrate help desk modules with other third-party applications such as invoicing, CRM, bug tracker, knowledge-base portals and more. For ...
                                                                                                                        • Zoho Desk's IM migration to the WhatsApp Cloud API

                                                                                                                          The WhatsApp Cloud API can be implemented by businesses of any size, for free-of-cost messaging. In the past, Desk supported fewer than 30 messages per second. But with the migration to the WhatsApp Cloud API, we can now support up to 80 messages per ...
                                                                                                                        • Assisted Data Migration Guide

                                                                                                                          Whether you’re moving from a cloud-based or on-premise system, you’ll need to find an efficient method of migrating your data to Zoho Desk. Our dedicated migration team can help you migrate your data safely and ensure your help desk operation is up ...
                                                                                                                        • Zwitch Data Migration: Export from Zendesk

                                                                                                                          When transitioning from a Zendesk account to Zoho Desk, the challenge lies in efficiently migrating critical data, such as customer information, ticket histories, agent interactions, referenced articles, and comments. A structured approach is crucial ...
                                                                                                                        • BSP Migration

                                                                                                                          Migration If you have an existing WhatsApp Business API client and wish to migrate it to a new setup using the same phone number, please follow the below mentioned steps or identify the changes to be made. What is a Business Service Provider (BSP)? ...
                                                                                                                          Wherever you are is as good as
                                                                                                                          your workplace

                                                                                                                            Resources

                                                                                                                            Videos

                                                                                                                            Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                            eBooks

                                                                                                                            Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                            Webinars

                                                                                                                            Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                            CRM Tips

                                                                                                                            Make the most of Zoho CRM with these useful tips.



                                                                                                                              Zoho Show Resources