Skip to main content

Zoho CRM — Application Overview

Overview​

Zoho CRM is a cloud-based customer relationship management platform used by sales, marketing, and customer operations teams to manage leads, contacts, accounts, deals, and customer interactions.

The Zoho CRM integration within the Wrk platform allows you to automate CRM Wrkflows by creating, retrieving, updating, and managing records across Zoho CRM modules using prebuilt Wrk Actions powered by the Zoho CRM REST API.

This document provides an overview of how Zoho CRM integrates into Wrk, how authentication works, general API behaviour, and a full list of available Wrk Actions.

Authentication

Zoho CRM uses OAuth 2.0 authentication for secure API access.

When connecting a Zoho CRM account in Wrk, users authenticate through Zoho’s OAuth authorization flow. After successful authentication, Wrk receives an access token and refresh token, which are used for all subsequent API requests.

How to Authenticate​

  1. Create a new Zoho CRM Connected Account in Wrk.
  2. You will be redirected to the Zoho login page.
  3. Sign in using your Zoho CRM credentials.
  4. Grant access permissions to Wrk.
  5. Wrk securely stores the access and refresh tokens.

General API Behaviour

Zoho CRM APIs follow standardised REST principles. Most operations are performed on module-based records such as Leads, Contacts, Accounts, and Deals.

Understanding the following behaviours helps ensure reliable Wrkflow execution.

Modules and Record Structure​

Zoho CRM organises data into modules.

Common modules include:

  • Leads
  • Contacts
  • Accounts
  • Deals
  • Tasks
  • Notes
  • Activities

Each record typically includes:

  • id — Unique identifier for the record
  • Created_Time — Timestamp of record creation
  • Modified_Time — Timestamp of last update
  • Owner — Assigned user
  • Module Fields — Module-specific attributes

Record IDs must be passed exactly as returned by the API when performing updates or retrievals.

Pagination​

Zoho CRM uses pagination to control large data responses.

Pagination parameters include:

  • page — Page number to retrieve
  • per_page — Number of records per page

Example:

GET /crm/v2/Leads?page=1&per_page=100

Key details:

  • Default maximum is typically 200 records per page.
  • Additional pages must be requested manually.
  • Pagination is required when retrieving large record sets.

Without pagination, large requests may return incomplete results.

Filtering Using Criteria​

Zoho CRM supports filtering records using criteria-based queries.

Example:

(criteria=(Email:equals:test@example.com))

Filtering capabilities:

  • Supports logical conditions
  • Supports comparison operators
  • Supports field-based filtering

Filtering reduces unnecessary data retrieval and improves performance.

Sorting​

Sorting is supported on many list-style requests.

Example:

sort_by=Created_Timesort_order=desc

Sorting is recommended when paging through records to ensure consistent ordering.

Rate Limits​

Zoho CRM enforces daily API usage limits based on:

  • Subscription tier
  • Number of licensed users
  • API usage category

If limits are exceeded, Zoho CRM returns:

HTTP 429 Too Many Requests

Best practices:

  • Use pagination
  • Use bulk operations when available
  • Avoid excessive polling

Available Wrk Actions for Zoho CRM​

  • Clone a record in Zoho CRM
  • Convert a lead in Zoho CRM
  • Create a record in Zoho CRM
  • Delete a note in Zoho CRM
  • Delete a record in Zoho CRM
  • Delete multiple records in Zoho CRM
  • Delete notes in Zoho CRM
  • Execute COQL query in Zoho CRM
  • Retrieve a note in Zoho CRM
  • Retrieve a record from Zoho CRM
  • Retrieve deleted records from Zoho CRM
  • Retrieve multiple records from Zoho CRM
  • Retrieve notes from Zoho CRM
  • Search records in Zoho CRM
  • Update a record in Zoho CRM
  • Update multiple records in Zoho CRM

Additional Resources​

Zoho CRM REST API Reference

https://www.zoho.com/crm/developer/docs/api/v2/

OAuth Authentication Documentation

https://www.zoho.com/accounts/protocol/oauth.html

Pagination Guide

https://www.zoho.com/crm/developer/docs/api/v2/pagination.html

Rate Limits Documentation

https://www.zoho.com/crm/developer/docs/api/v2/api-limits.html

Error Codes Reference

https://www.zoho.com/crm/developer/docs/api/v2/error-codes.html