Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Easy domain registration, transfer, and secured DNS management.

Try now
New

Payroll software with automated tax payments and filing.

Try now
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Unified payment solution built for all businesses.

Try now
New

Comprehensive email security and archiving for every business.

Try now
Suites

Cloud-based qualitative data analysis tool.

Try now
New

Online community platform for individuals and businesses to grow their network and brand.

Try now
New

Modern retail POS to sell better, manage your entire business, and join the digital revolution.

Try now
SuitesNew

Unified project management platform for intelligent, data-driven work.

Try now
Suites

Unified platform for customer service and support teams.

Try now

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

Migration to V2.0 - An Overview

The v1 APIs were deprecated on 31 December, 2018 and will reach their end-of-life (EOL) on 31 December, 2019. Hence, to keep accessing Zoho CRM, you need to migrate to the version 2 APIs.

Why API v2 is Better?

  1. Increased API credit limits - Maximum of 2,000,000 credits for the Ultimate edition of Zoho CRM, whereas v1 API has a maximum limit of 25,000 credits for the Enterprise edition

  2. Easy Parsing - Simple JSON format for input and response

  3. Improved Security - Supports OAuth 2.0 authentication protocol

  4. API names - Instead of display labels

  5. Notification APIs - Instant push notification on data changes

  6. Bulk APIs - Fetch up to 200,000 records or insert up to 25,000 records in one shot

  7. SDKs - Support for Server Side, Mobile, and Javascript SDKs

Migration checklist for developers

  1. Check whether you need to migrate your user's access tokens or re-authenticate with a new permission.

  2. Familiarize yourself with the new v2 syntax. v2 APIs accept only JSON input.

  3. Familiarize yourself with the changes in field attributes and field formats as mentioned in Differences - v1 and v2.

  4. Take a look at the API methods available in v1 and how different they are in v2 here.

  5. Update the error handling in your app to utilize v2 errors with proper status codes.

  6. Take a look at the Integration tasks and how to use them in your deluge script for v2 APIs here.

Following are the areas you need to look at to migrate from v1 and v2. Each of these sections explains the differences between the two versions in detail.

  1. Authentication
  2. Base URL
  3. Input format and API Names
  4. API Responses
  5. Integration Tasks
  6. Throttling
  7. Token Migration

Authentication

  • v1
  • v2
 

v1

https://crm.zoho.com/crm/private/xml/Leads/insertRecords?
newFormat=1
&authtoken=Auth Token
&scope=crmapi
&xmlData=<data>

v1 APIs use the auth token for authentication. This auth token is passed a parameter in the input.

v2

URL: https://www.zohoapis.com/crm/v2/Leads
Method: GET
Header: Authorization=Zoho-oauthtoken {access_token}

v2 APIs use Oauth 2.0 protocol for authentication. Here, the access token is passed in the header of the request. The OAuth 2.0 protocol improves security by providing access to only selected resources through Scopes.

Base URL

  • v1
  • v2
 

v1

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=AuthToken&scope=crmapi

Here, https://crm.zoho.com/crm/private/ is the base url.

v2

URL: https://www.zohoapis.com/crm/v2/Leads
Method: GET
Header: Authorization=Zoho-oauthtoken {oauth_token}

Here, https://www.zohoapis.com/crm/v2/ is the domain-specific base url for the US data center. Refer to Multi DC for more details about the domain-specific API URLs.

Input Format and API Names

  • v1
  • v2
 

v1

curl -X POST
'https://crm.zoho.com/crm/private/xml/Leads/insertRecords?newFormat=1&authtoken=***'
-d 'xmlData=<Leads><row no="1"><FL val="Lead Source">Web Download</FL><FL val="Company">Your Company</FL><FL val="First Name">Hannah</FL><FL val="Last Name">Smith</FL></row></Leads>'
  1. v1 APIs use field labels in their requests. In the create records example shown above, Lead Source, Company, First Name, and Last Name are the field labels in the Leads module.

  2. v1 APIs accept input only in xml format.

Refer to API methods for more details about the differences in API methods in v1 and v2.

v2

curl "https://www.zohoapis.com/crm/v2/Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newlead.json"
-X POST{
"data": [
    {
        "Company": "Zylker",
        "Last_Name": "Daly",
        "First_Name": "Paul",
        "Email": "p.daly@zylker.com",
        "Lead_Source": "Chat"
    }]}
  1. All v2 APIs use API Names instead of field labels. In the create record example shown above, Company, Last_Name, First_Name, and Lead_Source are the field API names in the Leads module.

  2. v2 APIs accept only JSON as the input.

Refer to API methods for more details about the differences in API methods in v1 and v2.

API Responses

  • v1
  • v2
 

v1

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/internal/xml/Leads/insertRecords">
 <result>
 <message>Record(s) added successfully</message>
 <recorddetail>
 <FL val="Id">525508000003633001</FL>
 <FL val="Created Time">2019-06-27 19:00:08</FL>
 <FL val="Modified Time">2019-06-27 19:00:08</FL>
 <FL val="Created By">
 <![CDATA[Patricia Boyle]]>
 </FL>
 <FL val="Modified By">
 <![CDATA[Patricia Boyle]]>
 </FL>
 </recorddetail>
 </result>
  1. v1 APIs return the response in either xml, JSON, or CSV format, and the required format is specified in the request URL as "https://crm.zoho.com/crm/private/xml/Leads/insertRecords..."

  2. The example shown here is the response to a create record request.

v2

{
"data": [
  {
    "code": "SUCCESS",
    "details": {
      "Modified_Time": "2019-05-02T11:17:33+05:30",
      "Modified_By": {
        "name": "Patricia Boyle",
        "id": "554023000000235011"
      },
      "Created_Time": "2019-05-02T11:17:33+05:30",
      "id": "554023000000527002",
      "Created_By": {
        "name": "Patricia Boyle",
        "id": "554023000000235011"
      }
    },
    "message": "record added",
    "status": "success"
  }
  1. All v2 API responses are in the JSON format, and the response contains keys that are API names of the respective module.

  2. v2 APIs return responses only in JSON or CSV formats.

Refer to API methods for more details about the differences in API methods in v1 and v2.

Integration Tasks

  • v1
  • v2
 

v1

  1. The syntax for v1 integration tasks contains "v1" after the service name.

  2. They use the "yyyy-mm-dd hh:mm:ss" time and date format.

  3. You can only trigger workflow rules via integration tasks.

  4. Updating multi-select lookup fields accept the values only in a string.

For more details, refer to Integration Tasks - Migration to v2.

v2

  1. The syntax for v2 integration tasks does not contain the version number in the syntax.

  2. They use the ISO time and date format.

  3. You can trigger workflow, blueprint, and approval rules via integration tasks.

  4. Updating multi-select lookup fields accept the values in a list.

For more details, refer to Integration Tasks - Migration to v2.

Throttling

  • v1
  • v2
 

v1

  1. The API limit for the Enterprise edition of v1 APIs is 25000 requests/day/organization or 500 requests per user license whichever is lower.

  2. PST time zone is considered to calculate the limits and the requests are reset at 00:00 AM PST.

Refer to API Limits for more details.

v2

  1. V2 APIs use a credit system and a concurrency limit to calculate the edition-based API limits. These limits have a 24-hour rolling window from the start of the call.

  2. Depending on the CRM edition, credits are deducted from your total credits based on the type of API call you make.

  3. v2 APIs also use concurrency and sub-concurrency limits to limit the maximum number of simultaneously active calls per app in any given instant.

  4. The v2 API limit for the Enterprise edition is 1,000,000 credits and 2,000,000 credits for the Ultimate edition.

  5. The API call limit has a 24-hour rolling window, from the start of the call.

  6. V2 APIs also use credits based on concurrency

Refer to API Limits for more details.

 

Token Migration

The Migration APIs help you obtain access and refresh tokens from the existing auth token.
The two types of migration APIs are

  1. Migration for Redirection-based Applications

  2. Migration for Self-Client Applications

  • Redirection-based
  • Self-Client
 

Redirection-based Apps

Use this API if your application has multiple users and you obtain their username and password to generate auth token, or if the users input their auth tokens.
Prerequisite:

  1. Before you can access this API, you must share your client ID(obtained from the developer console), auth token, auth token scopes, and the required OAuth scopes over an email to support@zohocrm.com for validation.

Refer to Migration for Redirection-based Applications for more details.

Self-client Apps

Use this API if your application uses only one auth token.
Refer to Migration for Self-Client Applications for more details.