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	https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Updateaticket
/api/(xml\|json)/(Contacts\|contacts)/updaterecords	https://desk.zoho.com/support/APIDocument.do#Contacts_Updateacontact
/api/(xml\|json)/(Accounts\|accounts)/updaterecords	https://desk.zoho.com/support/APIDocument.do#Accounts#Accounts_Updateanaccount
/api/(xml\|json)/(Tasks\|tasks)/updaterecords	https://desk.zoho.com/support/APIDocument.do#Tasks#Tasks_Updateatask
/api/(xml\|json)/(timeentry\|TimeEntry)/updaterecords	https://desk.zoho.com/support/APIDocument.do#TicketTimeEntry#TicketTimeEntry_UpdateaTicketTimeEntry
/api/(xml\|json)/(Contracts\|contracts\|Contract)/updaterecords	https://desk.zoho.com/support/APIDocument.do#Contracts#Contracts_Updateacontract
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/addrecords	https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Createaticket
/api/(xml\|json)/(Contacts\|contacts)/addrecords	https://desk.zoho.com/support/APIDocument.do#Contacts#Contacts_Createacontact
/api/(xml\|json)/(Accounts\|accounts)/addrecords	https://desk.zoho.com/support/APIDocument.do#Accounts#Accounts_Createanaccount
/api/(xml\|json)/(Tasks\|tasks)/addrecords	https://desk.zoho.com/support/APIDocument.do#Tasks#Tasks_Createatask
/api/(xml\|json)/(timeentry\|TimeEntry)/addrecords	https://desk.zoho.com/support/APIDocument.do#TicketTimeEntry#TicketTimeEntry_AddaTicketTimeEntry
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getrecords	https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Listalltickets
/api/(xml\|json)/(Accounts\|accounts)/getrecords	https://desk.zoho.com/support/APIDocument.do#Accounts#Accounts_Listallaccounts
/api/(xml\|json)/(Products\|products)/getrecords	https://desk.zoho.com/support/APIDocument.do#Products#Products_Listproducts
/api/(xml\|json)/(Contracts\|contracts\|Contract)/getrecords	https://desk.zoho.com/support/APIDocument.do#Contracts#Contracts_Listallcontracts
/api/(xml\|json)/(Timeentry\|timeentry\|TimeEntry)/getrecords	https://desk.zoho.com/support/APIDocument.do#TicketTimeEntry#TicketTimeEntry_ListTicketTimeEntries
/api/(xml\|json)/(Tasks\|tasks)/getrecords	https://desk.zoho.com/support/APIDocument.do#Tasks#Tasks_Listalltasks
/api/(xml\|json)/(Solutions\|solutions)/getrecords	https://desk.zoho.com/support/APIDocument.do#Articles#Articles_Listarticles
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getrecordsbyid	https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Getaticket
/api/(xml\|json)/(Contacts\|contacts)/getrecordsbyid	https://desk.zoho.com/support/APIDocument.do#Contacts#Contacts_Getacontact
/api/(xml\|json)/(Tasks\|tasks)/getrecordsbyid	https://desk.zoho.com/support/APIDocument.do#Tasks#Tasks_Getatask
/api/(xml\|json)/(Accounts\|accounts)/getrecordsbyid	https://desk.zoho.com/support/APIDocument.do#Accounts#Accounts_Getanaccount
/api/(xml\|json)/(Solutions\|solutions)/getrecordsbyid	https://desk.zoho.com/support/APIDocument.do#Articles#Articles_Getarticle
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getrecordsbycustomview	https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Listalltickets - use the viewId parameter in this API request https://desk.zoho.com/support/APIDocument.do#Views#Views_Listallviews - use this API to fetch the list of viewIds
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getrecordsbysearch	https://desk.zoho.com/support/APIDocument.do#Search#Search_TicketsSearchAPI
/api/(xml\|json)/(Contacts\|contacts)/getrecordsbysearch	https://desk.zoho.com/support/APIDocument.do#Search#Search_ContactSearchAPI
/api/(xml\|json)/(Accounts\|accounts)/getrecordsbysearch	https://desk.zoho.com/support/APIDocument.do#Search#Search_AccountSearchAPI
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getrecordsbyowner	https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Listalltickets - use the assignee parameter in this API request https://desk.zoho.com/support/APIDocument.do#Agents#Agents_Listallagents - use this API to fetch the list of agents
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/deleterecords	https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_MoveTicketstotrash
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getrequestthreads	https://desk.zoho.com/support/APIDocument.do#Threads#Threads_Listallthreads
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getattachments	https://desk.zoho.com/support/APIDocument.do#TicketAttachments#TicketAttachments_Listallattachments
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/getattachmentslist	https://desk.zoho.com/support/APIDocument.do#TicketAttachments#TicketAttachments_Listallattachments
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/addattachments	https://desk.zoho.com/support/APIDocument.do#TicketAttachments#TicketAttachments_Createanattachment
/api/(xml\|json)/(Requests\|Cases\|requests\|cases)/reply	https://desk.zoho.com/support/APIDocument.do#Threads#Threads_SendEmailReply
/api/(xml\|json)/(departments\|department)/getalldepartments	https://desk.zoho.com/support/APIDocument.do#Departments#Departments_Listalldepartments
/api/(xml\|json)/(portals\|portal)/getportallist	https://desk.zoho.com/support/APIDocument.do#Organizations#Organizations_GetallOrganizations
/api/(xml\|json)/emails/getfromaddress	https://desk.zoho.com/support/APIDocument.do#MailReplyAddress#MailReplyAddress_ListallMailReplyAddresses

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.

Redefine the way you work

with Zoho Workplace

Start your free trial

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.

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

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Enterprise	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
Offline 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
Free Forms	Travel
Prefill Forms	Non-Profit
Intake Forms	Legal
Form Designer	HR
Card Forms	Food
Assign Forms	Photography
Translate Forms	Real Estate
Electronic Forms
Notification Emails for Forms
Holiday Forms
Form to PDF
Email Forms CRM Forms Embeddable Forms Drag and Drop form builder HIPAA Forms Encrypted Forms

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

Zoho Pagesense Resources

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.

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

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 ...
Migrating From Zendesk to Zoho Desk
When transitioning from a Zendesk account to Zoho Desk, the challenge lies in efficiently migrating critical data like customer information, ticket histories, agent interactions, referenced articles, comments, and attachments. A structured approach ...
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 ...
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)? ...