Troubleshooting Developer Hub in Zoho CRM

APIs and SDKs

There is a "NO_CRM_ACCOUNT" error while generating access token.

Check if the OAuth code used was generated before a sandbox rebuild. If yes, rebuilding the sandbox makes the old code invalid, as rebuilding a sandbox is considered the account to be a new org and will have to generate a new token for further processing. Contact support if you have any issues.

An "Invalid_Code" error is occurring while generating access token.

This error could be due to an incorrect DC (data center) used during token generation, if it includes the correct domain corresponding to your data center (example: accounts.zoho.com, zoho.eu, zoho.in, etc.). Using an incorrect DC will result in an invalid code error.

It could also be because of reusing an old authorization code. Authorization codes (grant tokens) generated via the Developer Console are single-use only, and are valid for a maximum of 10 minutes. If the code is reused or has expired, the token request will fail with an "invalid_code error".

Unable to find the user identity of a New API key regenerated.

Please contact support with the Function name, a current API key screenshot, and the approximate time it last worked or the change was noticed for further assistance.

The records are created via API without custom mandatory fields.

Please check if the respective details like the correct layout and all mandatory field IDs were included in the API request body. On confirming, if you still find trouble, please contact support for further assistance. Please find this page for your Reference.

While making Get record/Search API calls, receiving a 204 error with empty response.

If you try to retrieve a record immediately after creating it, it may not be available for a few seconds while it propagates. Additionally, check if the record was converted. In that case, you will have to pass a param "converted" and value as "Both" so that it will check under converted records as well.

Unable to load the API credits page after receiving an "API limit exhausted" alert.

Please contact support via a live session for assistance or mail us at support@zohocrm.com.

While trying to make bulk API call, there is a "File not supported" error.

Ensure that the ZIP file contains no more than one CSV file, no hidden files, duplicate file ID reused, heavy files, or any files containing special characters. Upon verifying these checks, if you still have any trouble, contact support for further assistance.

Getting OAUTH_MISMATCH_ERROR while making an API request.

Check if the scope parameter was included in the authorization URL used for generating the access token and ensure the same scopes are used while generating the grant token along with the required scopes for the specific API calls included. If the issue persists, contact support for assistance.

Receiving a "RECORD_IN_BLUEPRINT" error while trying to update a record via API.

This error occurs when the record is currently in a Blueprint process. If you still need to update records, please use the Blueprint Transition API to progress the record to the next state as per the configured Blueprint to allow the record to update appropriately without violating the Blueprint constraints. Check and contact support if you still should have any concerns.

Receiving a"TOO_MANY_REQUESTS" error while making API calls.

This error occurs when your requests exceed one of Zoho CRM's API limits. This is most commonly the concurrency limit (too many simultaneous/open requests), but it can also be the daily credit/request limit or a short-term burst limit. Zoho enforces these limits to protect system performance and reliability. Review your API usage, throttle the number of simultaneous requests, batch data wherever possible, and implement retry logic with exponential back-off. Refer to this link for more details on Zoho CRM API Limits. Contact support if you need any assistance.

Unable to create a refresh token while generating access token.

The OAuth authorization flow does not return a refresh token when it is set to "online". Use access_type=offline and prompt=consent in the authorization URL to get a refresh token which will return on the first consent. Ensure the redirect URI exactly matches the Developer Console entry, and store the refresh token securely. If you have any trouble, contact support for assistance.

While using "equals operator" in the Zoho CRM Search API call, it returns partial matches.

The Search API's equals operator can return more than exact matches in certain cases, such as when multiple conditions are combined, or when a single-line field value contains special characters, in which case similar-looking or partially-matching records may be returned. For reliable exact-match results, use the COQL API with the = comparator.

Unable to make Parallel execution using Bulk API.

Multiple Bulk APIs call do not support parallel execution. It processes one bulk job at a time per module / per user. Start a new bulk operation (import, export or update) only completion or rejection of previous job; it will allow to proceed further. The previous request when completed or rejected, then it can be processed further.

Widgets

Unable to build a custom widget for our client Portal.

Widgets are not supported for Client Portal.

While accessing widget configured as WebTab, there is a "Page not found" error.

Follow the steps found here, and pack the code accordingly. If you still find any trouble, contact support for further assistance.

Client Script

Unable to see ZDK.Apps in the client script environment.

In newly created modules, ZDK.Apps may not be available in the Client Script environment. As a result, references such as ZDK.Apps.CRM.<ModuleName> are not recognized, causing module references and associated methods to fail or behave unexpectedly. Enabling ZDK key from the backend would solve the issue. Kindly contact support online for further assistance.

Unable to edit the client scripts after data center (DC) migration, showing "The Client Script you are accessing is not available."

Contact support to connect with our coding experts in a live session for assistance.

Unable to include external libraries like Node.js or Crypto-Js in the Client Scripts.

Currently, importing external libraries or using Node.js packages in Zoho Client Scripts are not supported.

A Client Script written to hide all views except "My Contacts" still shows all views in Kanban View.

This is a known behavior. Currently, the restriction is not applied in Kanban View. The request is under evaluation and may be included in a future update.

Unable to write a Client Script for the New Team module.

Currently, Client Script for Zoho CRM Teams module is not supported, but it is in the being worked on. Once we have completed the analysis, the updates will be shared.

One of the client script written for OnBeforeUpdate for Stage field is not working as expected.

If there is a client script set to trigger on "OnBeforeUpdate" for "Stage field", the script is intended to prevent the "Stage" field from being changed to "Closed Lost" by showing an alert and returning false. We understand that the Expected behavior is to trigger only after the user saves the change (using the blue check mark). However, the current behavior is like the script triggers immediately when the user selects Closed Lost, even before saving.

Since the Stage field is treated differently from others, some client script event support is not yet implemented. As a workaround, we suggest you configure the client script using "OnMandatoryFormLoad Event" for "Closed Won/Lost stages".
We are working on updates to this behavior, and it can be expected in future releases.