Introducing the new Zoho CRM V7 APIs and ZDK CLI
Hello Enterprise Community,
We have recently launched a couple of very exciting features for developers working in Zoho CRM, the updated V7 APIs and the new ZDK Command-Line Interface (CLI)!
What does this mean?
The Version 7 APIs introduce a ton of new features to our CRM's API library, including the ability to clone records, capture user action history, schedule exports, and manage duplicates.
The new ZDK Command-Line Interface (CLI) feature enables a developer-friendly way to interact with and manage your CRM organization's customization metadata. If you're a developer working on Zoho CRM customizations and wish to track these changes using your preferred Version Control System (VCS) such as Git or Mercurial, the ZDK CLI provides an effective solution for this.
More details on both of these features below!
Zoho CRM V7 API
Here is a list of what's been added in the new V7 APIs:
Record Clone API: Create a copy of a parent record, with the option to modify or add field values when needed.
Export Audit Log API: Schedule audit log exports with criteria, track job statuses, and download completed files.
List Available APIs: Use this to help you find the right API for the task you are trying to accomplish.
Duplicate Check Option API: Manage the Duplicate Check Preference settings in the Leads/Contacts modules.
Picklist Values API: Retrieve configurations details for picklist fields, including display values, color codes, etc.
Mass Delete Tags API: Remove multiple tags from a module at once by scheduling jobs with this API.
Data Enrichment API: Manage Data Enrichment configuration, including mapping fields, triggering enrichment, and accessing enriched data.
Cadence API: Fetch cadence details and manually enroll or un-enroll records in a Cadence.
Check out the Changelog and What's New pages for more details.
ZDK Command-Line Interface (CLI)
We are excited to introduce the Zoho Development Kit CLI (Beta), a suite of powerful command-line tools that streamline managing your organization’s metadata and enhance team collaboration when customizing the CRM. Designed specifically for developers and partners, ZDK CLI simplifies working with Zoho CRM.
Key Features of ZDK CLI:
Metadata Management: Edit and update metadata such as profiles, roles, modules, fields, and layouts.
Widget Management: Easily manage widgets directly through ZDK CLI.
Version Control Integration: Track changes using your preferred Version Control Software with metadata pulled from Zoho CRM.
Seamless Customization: Export and transfer metadata between CRM organizations for easy customization and management.
How to initialize and authorize ZDK CLI followed by a demo using ZDK CLI to create a user profile in Zoho CRM
The commands were intentionally created to be similar to mercurial commands, to reduce the learning curve while getting started with ZDK CLI.
Here are some of the examples of the commands that are available:
zdk org:pull: Pulls the metadata to the local ZDK CLI project directory.
zdk org:pull:update: Updates the local ZDK CLI project directory with the pulled data.
zdk meta:create: Adds new Zoho CRM metadata. Supported metadata types are modules, fields, layouts, widgets, profiles, and roles.
zdk org:push: Pushes changes to org.
zdk org:export: Exports the ZDK CLI project in a zip file to share it with other developers.
If you are interested in learning more, please check out our Quick Start Guide and begin working with this new tool!
ZDK CLI is available in Enterprise, CRM Plus, Ultimate, and Zoho One editions including trial editions. In the current beta release, only sandbox environments are supported.