Before You Begin
Before you begin, you will need to obtain authentication information from Zoho CRM.
Steps to Obtain Client ID and Client Secret for Zoho CRM OAuth 2.0:
Go to the Zoho Developer Console.
Log in with your Zoho account credentials (the account that has access to Zoho CRM).
Once logged in to the API Console, click Add Client, navigate to My Apps to create a new OAuth Application.
Click Server-based Applications.
On the Create New Client screen, provide the following information:
Client Name: Choose a descriptive name for your app.
Homepage URL: This is the domain where your application is hosted.
Authorized Redirect URLs: This is the URL where Zoho will send the user after authentication. It’s part of the OAuth flow and is used to capture the Authorization Code. For example:
https://portal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/app
This URL will be used during the OAuth 2.0 flow to exchange the authorization code for an access token.
To authenticate against a different regional instance, select the appropriate region in the Settings tab and toggle the slider for the required data center based on your region. For example, to use the European instance, toggle EU (zoho.eu).
Click Update. Zoho CRM generates a Client ID (public identifier for your app) and a Client Secret (a confidential credential that must be kept secure and not shared publicly).
Installation Instructions for Integration Setup
Go to Subscriptions, click Search Certified Integration Marketplace, then click Subscribe.
Click the Zoho CRM integration tile.
On the Subscription Settings page, click the Subscribe button.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: ZohoCRM – Production
Select Create Default Mappings (recommended). If you don’t want to create default mappings and want to create all mappings from scratch by yourself then uncheck this box.
Provide the API URL endpoint for your Zoho CRM instance.
Example Environment URL for Production:
https://www.zohoapis.com/crm
Provide the Client_Id and Client_Secret.
At Raise Custom Field Not Found Exception, select True to raise an exception, or False to ignore it. The exception can occur when:
A field was deleted
The user does not have permission to view the field
The field exists in Sandbox but not in Production
Select the Region where the Zoho CRM data is hosted.
Click Apply.
Initiate the OAuth Flow and Generate the Access Token
To initiate the OAuth flow and obtain an access token for API communication with Zoho CRM:
Go to the Zoho CRM Subscription that was created earlier.
Enter all authentication details, such as the Client ID and Client Secret (generated above).
Click the Authentication icon in the top toolbar.
A new browser window opens.
A new browser window opens.
Click Accept.
When the authentication is validated, Zoho CRM displays a success message.
After the confirmation page is displayed, close the window.
Refresh the subscription page.
If successful, the Access Token and Refresh Token are populated.
If an error occurs, double-check that all settings match the configuration described above.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
Data Sync Test
Initiate a sample data pull. (To iPaaS.com).
Initiate a sample data push. (From iPaaS.com).
Functionality Test
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Common Issues and Solutions
Invalid API Domain
Issue: Using a generic or incorrect domain for API requests.
Solution:
To resolve this issue, ensure that a valid region is selected in the Subscription Settings (only supported regions are available in the dropdown) and then authenticate the integration. The selected region determines the API domain used by the integration, and this process automatically populates the persistent data with the corresponding regional API domain.
Users should verify that the selected region is correct, as this selection is what determines the domain value used by the integration.
Authentication Failures
Issue: Requests return 401 Unauthorized or invalid_client.
Solution:
Ensure you are using the correct Client ID and Client Secret generated in the Zoho API Console.
Use a valid OAuth 2.0 access token and refresh it before expiry using the refresh token
Authentication Failures Using Incorrect Region
Issue: Authentication Request. Failed to convert temporary code into a permanent token
Solution:
Verify that the correct Region is selected in the Subscription Settings before initiating authentication.
Only supported regions are available in the dropdown; ensure the selected region matches your Zoho account’s data center.
Re-authenticate the integration after selecting the correct region so the API domain is computed and persisted correctly.
Insufficient Permissions
Issue: User cannot access store data or update products/orders.
Solution: Verify that the Zoho user account has the required role (e.g., Admin in Zoho CRM) and that the scope requested in OAuth includes the required modules (e.g., ZohoCRM.products.ALL, ZohoCRM.orders.ALL).
Invalid or Missing IDs
Issue: API requests fail due to referencing non-existent objects (e.g., product ID, order ID, customer ID).
Solution: Always fetch and validate IDs with the appropriate GET API endpoints before using them in POST/PUT/DELETE requests.
Incorrect Data Format
Issue: API rejects fields like dates, currency, or JSON payload format.
Solution:
Use ISO 8601 format for dates (e.g., YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
Ensure numbers (price, quantity) are provided as valid integers or decimals.
Validate request body against Zoho CRM API documentation.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.