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

Changelogs

We regularly enhance Zoho CRM APIs with new features to suit your evolving business requirements. The following changelogs detail all significant changes introduced in version 7 of Zoho CRM APIs. 

Navigating through code samples: In each of the code samples, newly introduced keys are presented in green, existing keys that are updated are presented in orange, and keys that are removed are presented in red.

Version 7

The Zoho CRM APIs with updates specific to V7 are listed below.

  1. Modules API 
    • From V7, a Zia insights module will be created automatically whenever you enable any Zia features for a specific module. You can fetch the list of these Zia insights modules using the Modules API.
      • Zia features : Field Prediction, Churn Prediction, NBX, Recommendation, Call Transcription, Best Time for Call, Best Time for Mail, Owner Recommendation, Vision, Best Time for Notes, and Best Mode to Contact.
    • When you enable Zia features for a module, a corresponding Zia Insights module will be created, from V7. 
      • Zia features : Field Prediction, Churn Prediction, NBX, Recommendation, Call Transcription, Best Time for Call, Best Time for Mail, Owner Recommendation, Vision, Best Time for Notes, and Best Mode to Contact. 

        To see the fields available within the created Zia Insights module, use the GET - Fields Metadata API 

        Note : Use the corresponding Zia insight module's API name in the "module" parameter. Example : /settings/fields?module=Leads_Insights__s

    • A new "layout_associations" JSON array key is introduced in the response of the GET - Fields Metadata API from V7, representing the layouts with which the fields are associated in a module.
    • While fetching a particular layout using its unique ID in a module, the "subform_properties" JSON object in the response of the GET - Layouts API represents whether any field is pinned in the subform. 
      Note: This feature is currently in "Early Access." Contact the support team at support@zohocrm.com to request access.
       
    • The "mode" key will be listed in the GET - Layouts API, representing the section's mode in a layout. 
      • Possible values 
        • All modules except "Events" :default_create, quick_create, and business_card.
        • Events module : create, view, and quick_view
        • Subform: create and view
        • Wizard : create
  2. Users API

    • From V7, the category key has been changed to type__s.
    • The structure for the values has been changed. For example, "category":"regular_user" to "type__s": Regular User. An underscore(_) between values has been replaced with a space.
    • The Lite User value in the type__s key has been changed to Team User from V7.
  3. Related List API
    • Introduced in V7, the "status" key for each related list represents its visibility in the module. 

      Possible Values : visible, user_hidden, and scheduled_for_deletion.

  4. Territories API
    • From V7,  You can retrieve a maximum of 2000 records in a single API call, using the Territories API.  The maximum value of "per_page" key has been increased from 200 to 2000.
    • From V7 onwards, the "include" parameter is introduced to retrieve territory specific criteria rules. Possible Values: lead_rule_criteria, account_rule_criteria, and deal_rule_criteria in a comma separated value.  

      Note : In V7 GET Territories API, the lead_rule_criteria, account_rule_criteria, and deal_rule_criteria will not be displayed unless you specify them to the include parameter. 

    • The "api_name" key is introduced from V7 to represent the API name of a territory.

    • From v7, the "used_count" JSON object key is introduced within the "component" JSON object to denote the feature's usage count for your edition.
    • From V7, all custom field datatypes are grouped together under a single "Custom Field" component. Each specific datatype (like text, integer and so on) is represented as a separate component within this main "Custom Field" component in the GET - Features API's response.
       
    • From V7 onwards, the "Personal Health Field" will be included in the response of the GET - Features API.
    • The value of the "code" key in the response of the Mass Convert Lead API has been changed from "SUCCESS" to "SCHEDULED".
    • In the GET - Files API, if you do not pass the "id" parameter, the system will return an "HTTP 400 - REQUIRED_PARAM_MISSING" error response from V7. If you specify an invalid ID in the "id" parameter, the response will be "HTTP 204 - NO_CONTENT".
  5. Blueprint API
    • In a blueprint record, the "current_picklist" JSON object is introduced in the GET - Blueprint API response from V7, specifies the details of the current picklist option. 

      The current_picklist includes :

      • colour_code (string): Represents the hex color code of the current picklist option.
      • id (string): Represents the unique ID of the current picklist option.
      • value (string): Represent the value of the picklist option.
    • In the User Groups API, you can do criteria-based searches for user groups , using the "filters" (singular and multiple filters) parameter introduced from V7.
    • Using the Associated Groups of a User API, from V7, the "include" parameter is introduced to know the sources available in a group a user is associated with. Supported value is sources.
The below listed enhancements have been supported from V7.
  • The field limit in the SELECT column of a query has been increased from 50 to 500.
  • The CVID support has been given from V7.
  • You can retrieve the metadata of the fields specified in the SELECT column by using the include_meta key.
  • Duplicate fields are restricted in the GROUP BY, ORDER BY, and AGGREGATE clauses. If duplicate fields are used in these clauses, a DUPLICATE_ERROR will be thrown.
  • Aggregate Fields : A maximum of five aggregate fields can be given in a query.
  • The value limit for the in and not in operators has been increased from 50 to 100.
  • You can retrieve up to 100,000 records using the LIMIT and OFFSET clauses.
  • You can fetch territory information from a module by including the territory field API name in the SELECT column.
  • The Full Name will be retrieved based on the current user's display name pattern, as set in their preferences.
  • The what_id supports more than one module in a single query.
  • You can retrieve the consent-related information using the Consents Lookup fields in your query.
  • From V7, when you specify a lookup field in the SELECT column of a query, the response includes the associated record’s display field value under the "name" key within the "lookup"JSON along with the "id" key.
    • Note:
      If you query the Users lookup field in the SELECT column, the corresponding record’s last name (display field) will be displayed in the "name" key of the corresponding  "lookup" JSON response.
    • Display field value will not be available for Consent Lookup and Multi-Module Lookup (MML) fields.
  • Multi-module Lookup (MML):
    • You can retrieve the inner fields of the associated module. You can also query the module's name associated with a record in the MML. Refer to the Multi-module Lookup section for more details.
  • Until V6, the only supported comparators for Profile Image field (with "api_name": "Record_Image" and "data_type": "profileimage") were "is not null" and "is null".
    • The Profile Image field supports the following comparators: "is null", "is not null", "=", "!=", "in", "not in", "like", "not like".
  • The Rollup Summary field now supports additional comparators:  "=", "!=", ">=", ">", "<=", "<", "between", "not between", "in", "not in", "is null" and "is not null". Until V6, only "is null" and "is not null" were supported.
    • Note: From V7, the response for the Date and Datetime return types of the Rollup Summary field will be provided in their respective formats.
  • JOINs in COQL:
    • The Base JOIN support limit has been increased from two to five. It means, a single query can have a maximum of five JOINs.
    • The SELECT Column JOIN has been introduced, supporting up to 15 JOINs in a single query.
    • From V7, If there are two lookup fields pointing to the same module (Example: Owner.role and Created_By.profile pointing the Users module) in the SELECT Column JOIN, then the both the lookup fields will be treated as a single JOIN

         Refer to the JOINs in COQL for more details.

  • From V7, subqueries have been introduced. A single query can nest up to five subqueries. Refer to the Subquery documentation for more details.