nstallation Instructions for Integration Setup
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://stagingportal.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.
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).
Installing the Zoho CRM Integration
Go to Subscriptions and click Search Certified Integration Marketplace and 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).
NOTE: 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.
Configure Zoho CRM Integration Settings
You will use the settings you created and saved in the Before You Begin section.
Navigate to the Edit Integration [Zoho CRM], edit the settings, and at the Authorization Type, select OAuth initiated within iPaaS.
Scroll to the bottom of the page to the Versions section and click the edit icon
.
On the Edit Version page go to the OAUTH URL TEMPLATE text box and enter:
https://accounts.zoho.com/oauth/v2/auth?scope= ZohoCRM.modules.ALL&client_id={Client_Id}&response_type=code&redirect_uri={SystemTypeVersion:RedirectUrl}&access_type=offline&state={iPaaSState}
Scroll to Custom Fields.
Click Add.
Name the field RedirectUrl and paste the following in the next field for the redirect URL:
https://stagingportal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/app
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 page 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 iPaaS.com subscription page.If successful, the Access Token and Refresh Token will be 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.
Common Issues and Solutions:
Invalid API Domain
Issue: Using a generic or incorrect domain for API requests.
Solution: Use your region-specific Zoho Accounts domain.
Examples:
Authentication Failures
Issue: Requests return 401 Unauthorized or invalid_client.
Solution:
Ensure you are using the correct Client ID and Client Secret generated in Zoho API Console.
Use a valid OAuth 2.0 access token and refresh it before expiry using the refresh token.
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. Additional resources include:
Documentation: API Introduction
Support Portal: https://support.ipaas.com/en/
Contact Information: Contact iPaaS.com
Zoho CRM Support and Troubleshooting
Documentation
Find comprehensive guides, API references, and tutorials on Zoho’s official documentation sites:
Support Portal & Plans
Zoho provides multiple support options depending on your subscription level:
Standard Support: Included with all Zoho CRM subscriptions. Covers basic troubleshooting, configuration help, and access to the knowledge base.
Premium Support: Faster response times, priority case handling, and personalized onboarding assistance.
Enterprise Support: Tailored support for large organizations, including a dedicated Technical Account Manager and quarterly business reviews.
Submission Portals
General Support: Submit tickets via the Zoho Support Portal.
API & Developer Issues: Raise requests via the Zoho Developer Portal or through the developer forums.
Product Feedback & Feature Requests: Available through Zoho CRM in-app feedback option or the Zoho Community Forums.
Contact Info
For direct assistance:
Email: support@zohocrm.com (or via Zoho Support)
Phone (Regional): Local support numbers vary by geography; available in your Zoho CRM admin portal under Support.
Live Chat: Available directly within the Zoho CRM web portal for subscribed customers.