This template process exchanges a Zoho API grant token for a refresh token that can be used in other Zoho CRM templates.

Prerequisites

This template assumes that the following prerequisites are in place:

• The client ID and client secret for Zoho are available.
• It is known which domain your Zoho instance is in, e.g., EU or America.
• The grant token has been created in the Zoho API console and has a scope that matches all required use cases.

Implementation and Usage Notes

The purpose of this template is to exchange a single-use Zoho API grant token for a refresh token with unlimited uses, that can be used in other Zoho templates for API access, by passing it to them as a process variable.

The grant token can be created in the Zoho API console, and it is required to generate the actual access and refresh tokens for API access. The refresh token obtained using this template is used in the other Zoho templates for generating the access token for each process run.

When creating the grant token in the Zoho API console, it should be ensured that the grant token has all scopes required for your use cases. For example, if you are reading contacts in one process and inserting products in another, the grant token should at least have the scopes ZohoCRM.modules.contacts.READ and ZohoCRM.modules.products.ALL. Another possibility is to use the universal scope ZohoCRM.modules.ALL.

The process variables include the client ID and secret for Zoho, the region-specific Zoho accounts domain, and the grant token to be used for the exchange.

Error Handling

This template checks for errors after sending the token exchange request to the Zoho authorization server, and throws an exception if errors are encountered. If transient errors are expected, the task can be configured to retry the connection a given number of times before failing.