Zoho CRM

Provides integration with Zoho CRM to query, create, update, and delete module records using live Zoho metadata.

Revision History

0.0.0.3 - Initial release.
0.1.0.4 - Improved metadata-driven templates and response definitions.

Connection

Use this Connection to store the Zoho OAuth settings, region, and API domain used by all Zoho CRM methods.

Property Type Description
Region String Zoho region used for OAuth. Supported values are US, AU, EU, IN, CN, JP, CA, and SA. Defaults to US.
Client ID String OAuth client identifier issued by Zoho.
Client Secret Masked OAuth client secret issued by Zoho.
Scope String Comma-delimited Zoho scopes requested during authorization. Defaults to ZohoCRM.modules.ALL,ZohoCRM.settings.ALL.
Access Token Masked OAuth access token used for Zoho CRM API requests. Flowgear refreshes this value automatically when it expires.
Refresh Token Masked OAuth refresh token used to renew the access token.
API Domain String Zoho API domain returned during token exchange or refresh.

Setup Notes

  • Create a Zoho OAuth client that can access Zoho CRM modules and settings metadata.
  • Configure the Connection with the correct Region, Client ID, and Client Secret.
  • Complete the OAuth authorization flow to generate the Refresh Token and API Domain.
  • Test the Connection to confirm that it can authenticate and read Zoho CRM module metadata.
  • Template discovery requires a working Zoho CRM Connection because the Node loads modules and fields from live CRM metadata.

Methods

The Node exposes methods to query and manage Zoho CRM records. Templates are generated for each available module using live Zoho metadata.

Query

Queries records in a selected Zoho CRM module and returns one response row per record.

Parameter Type Description
Connection Connection Zoho CRM Connection used to authenticate the request.
Request Object Query definition containing the module, fields, and optional filters.
Request.Module String Zoho module API name to query.
Request.Fields String Comma-separated list of Zoho field API names to return. The generated template selects the first 40 readable fields by default and lists all readable fields in the sample.
Request.Id String Optional Zoho record ID for a single-record query.
Request.Criteria String Optional Zoho criteria expression for a list query.
Request.SortBy String Optional field API name used to sort the results.
Request.SortOrder String Optional sort order. Use asc or desc.
Return Type Description
Response Array Zoho records containing the selected fields, module, recordId, providerStatus, providerCode, and the original provider response. A successful query with no matching records returns no rows.

Create

Creates records in a selected Zoho CRM module and returns one response row per request item.

Parameter Type Description
Connection Connection Zoho CRM Connection used to authenticate the request.
Request Array Stream of create request items.
Request[].Module String Zoho module API name in which to create the record.
Request[].Data Object Writable Zoho field values for the new record.
Batch Size Integer Maximum number of same-module request items sent to Zoho in one API call. Defaults to 100 and must be at least 1.
Return Type Description
Response Array One result per request item. Each row includes module, recordId, providerStatus, providerCode, the provider response, and a Flowgear object containing IsSuccess, Message, and the original Request.

Update

Updates records in a selected Zoho CRM module and returns one response row per request item.

Parameter Type Description
Connection Connection Zoho CRM Connection used to authenticate the request.
Request Array Stream of update request items.
Request[].Module String Zoho module API name containing the record.
Request[].Id String Zoho record ID to update.
Request[].Data Object Writable Zoho field values to apply to the record.
Batch Size Integer Maximum number of same-module request items sent to Zoho in one API call. Defaults to 100 and must be at least 1.
Return Type Description
Response Array One result per request item. Each row includes module, recordId, providerStatus, providerCode, the provider response, and a Flowgear object containing IsSuccess, Message, and the original Request.

Delete

Deletes records from a selected Zoho CRM module and returns one response row per request item.

Parameter Type Description
Connection Connection Zoho CRM Connection used to authenticate the request.
Request Array Stream of delete request items.
Request[].Module String Zoho module API name containing the record.
Request[].Id String Zoho record ID to delete.
Batch Size Integer Maximum number of same-module request items sent to Zoho in one API call. Defaults to 100 and must be at least 1.
Return Type Description
Response Array One result per request item. Each row includes module, recordId, providerStatus, providerCode, the provider response, and a Flowgear object containing IsSuccess, Message, and the original Request.

Usage Notes

  • Select a module-specific template to populate the Request and Response fields from live Zoho CRM metadata.
  • Use Zoho field API names in Request.Fields, Request.Criteria, and mutation Request[].Data values.
  • When you provide Request.Id to Query, the Node reads a single record instead of running a list query.
  • The Node handles query paging internally. You do not need to provide Zoho page values.
  • Create, Update, and Delete group adjacent request items by Module and submit each group in batches up to the selected Batch Size.
  • Invalid mutation items return a failed response row. Other items continue processing.

Known Issues

  • The Node supports Zoho CRM records APIs only. It does not support COQL or related-record operations.