Kaizen #120 - A Guide to API Calls in Zoho CRM Sandboxes
Hello everyone!
Welcome back to another post in our Kaizen series. This week, we will discuss in detail about the sandbox environment in Zoho CRM, and how to make API calls to the sandbox orgs.
Environments in Zoho CRM
Zoho CRM empowers your business with robust developer tools. But what if you want to experiment without affecting your live data? Or if you want to try out a widget or a workflow before pushing them live to your customers? We have got you covered with our environment options.
Zoho CRM offers three environments:
Production - The production environment is your live CRM account, which you use for business operations.
Developer - This environment acts as a playground for developers to build and test custom integrations and apps. Changes made here cannot be directly applied to the production account.
Sandbox - This is a secure testing ground where you can experiment without disrupting your live production environment. Tinker with settings, workflows, and features without disrupting your live data. Test, identify issues, and perfect your changes before deploying them to your production environment.
Creating a Sandbox:
CRM admins can create multiple sandboxes in one account for independent testing of different configurations. The number of sandboxes allowed depends on your CRM edition. You can create a sandbox from Setup > Data Administration > Sandbox. For more details on the available configurations and settings, refer here. Note that the sandbox environment is exclusive to the enterprise and above editions.
Once your sandbox accounts are set up, you can view them at CRM Setup > Data Administration > Sandbox. Access the sandbox organization you want, and you can go about working in the sandbox in the same way you would work in the production setup. You can make the necessary changes, utilize sandbox data for validation, and, once satisfied, deploy them to the production environment.
Making API calls in the Sandbox environment
- Register your application : Before you get started with authorization and make any calls using the Zoho CRM APIs, you need to register your application with Zoho CRM. Follow the steps explained in this document to register your application.
- Generate grant token : To use the Zoho CRM APIs, you must authenticate the application to make API calls on their behalf with an access token. The access token, in return, must be obtained from a grant token (authorization code). Choose the desired organization under the sandbox environment from the list displayed when generating the grant token. For more details on how to generate a grant token, please refer to this document.
- Generate Access Token and Refresh Token : OAuth2.0 requests are usually authenticated with an access token, which is passed as bearer token. Use your domain-specific Zoho Accounts URL https://accounts.zoho.{domain} to generate the tokens.
- Identifying token environment (optional) : With the access token in hand, you might wonder: Which environment does this token belong to? This can be determined using the Organization API using https://www.zohoapis.{domain} regardless of the token's environment. The type key in the API response contains information regarding the environment linked to the access token - production, developer, or sandbox. Please note that this functionality is supported only from Zoho CRM API version 6 onwards.
- Making API calls : Now that you know the token's environment, use the sandbox-specific URL https://sandbox.zohoapis.{domain} for API calls to the sandbox environment. Please note that attempting calls using tokens generated for other environments will result in a DOMAIN_TOKEN_MISMATCH error.
Points to remember :
- Generate the grant token for the corresponding sandbox organization to avoid the DOMAIN_TOKEN_MISMATCH error.
- The accounts URL for generating tokens remains the same for both sandbox and production environments - https://accounts.zoho.{domain} .
- The Get Organization API response includes a type key, which contains information regarding the environment your access token is authorized for (production, developer, or sandbox).
Multiple Sandbox Accounts and API Calls
Each sandbox environment within your Zoho CRM account acts as a separate organization. To ensure your API calls land precisely where intended, follow these guidelines:
- Separate Grant Tokens for Each Organization : You should generate separate grant token for each organization, whether within a sandbox environment or the production environment.
- API Call URL for All Sandboxes: The API call URL remains consistent for all sandboxes: https://sandbox.zohoapis.{domain}. However, to target a specific sandbox organization, you must generate the grant token specifically for that organization.
Frequently Asked Questions
Q. How many sandboxes can I have in my Zoho CRM account?
A. The number of sandboxes you can have depends on your Zoho CRM edition. Please refer to this document to know the specific limits.
Q. Do sandbox API calls affect my production data?
A. No, API calls made from the sandbox environment are isolated from your production data.
Q. Do I need different account URLs for generating tokens in sandbox and production?
Q. Can I use the same access token for API calls in both the sandbox and production environments?
A. No, each organization in each environment requires its own access token.
Q. Is there a specific URL for making API calls from the sandbox environment?
A. Yes, use https://sandbox.zohoapis.{domain} for sandbox calls.
Q. How do I find if the token is generated for the sandbox or any other environment?
A. In order to find whether a token is generated for a sandbox or other environment, kindly use the Organization API which will return the type for which the token is generated. Please note that this support is available from V6 only.
Q. What does the "DOMAIN_TOKEN_MISMATCH" error indicate during API calls in the sandbox environment?
A. This error occurs when using tokens from a different environment or domain in your API calls. For example, you will get this error if you attempt to use an access token generated for the production environment in the sandbox environment
Q. Do I need to register my application differently for the sandbox environment?
A. No, you use the same application registration process for both sandbox and Production environments. However, you need to generate separate grant tokens for each environment.
Q. Do I need to use different client IDs and client secrets for the sandbox environment compared to production?
A. No, you can use the same client ID and client secret for both environments. However, you'll need to generate separate access tokens for each org.
We hope that you found this post useful. Let us know your thoughts in the comment section or reach out to us at support@zohocrm.com.
Stay tuned for more insights in our upcoming Kaizen posts!
Happy Coding!
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Anu Abraham
David
Sticky Posts
Kaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes areKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Settings Icon No Longer in ZOHO Desk?
In ZOHO desk, there has been a gear icon for settings. as of yesterday, it is no longer there. I showed up briefly this morning but is gone again. Anybody else experiecing this?Tip #43 - Track, Review, and Analyze Your Assist Sessions with Reports-'Insider Insights'
Did you know you can generate detailed reports for both remote support sessions and unattended access sessions in Zoho Assist? This makes it easy to monitor technician activity, measure efficiency, and review customer interactions. Let us now take a closerFunction #20: Custom calculation in item table of invoices
When you create an invoice in Zoho Books, the 'Amount' of a line item is typically calculated as the product of the "Quantity" and the "Rate" of the item. For instance, if an item has a sales rate of $50 and a quantity of 5 is sold, then the amount wouldSimplified Call Logging
Our organization would like to start logging calls in our CRM; however, with 13 fields that can't be removed, our team is finding it extremely cumbersome. For our use case, we only need to record that a call happened theirfor would only need the followingSub form doesn't as formula field
Is it possible to get formula field in sub form in futures?Week date range in pivot table
Hello, I need to create a report that breakouts the data by week. I am using the pivot table report, and breaking out the date by week, however the date is displayed as 'Week 1 2014' format. Is there anyway to get the actual dates in there? ex. 1/6/2014-1/12/2014 Thanks,How do I get Status History data of my Projects?
I want to build a table in Zoho Analytics that Groups by Date, when Projects entered a certain status. I cannot find Status History or any such useful data available in the Setup of my Data Source sync. Please advise how I can achieve this?Is it possible to hide fields in a Subform?
Since layout rules cannot be used with Subforms, is there another way, or is it even possible, to hide fields in a subform based on a picklist fields within said subform? For example, if the Service Provided is Internet, then I do not want to see theWeekly Tips :Instantly find what you need with Attachment Viewer
Your inbox must be packed with project emails, shared notes, and scattered attachments. You are looking for one specific file—a presentation slide or maybe a media clip from a team update—but don’t want to dig through endless email threads or switch betweenMissing Zoho Desk integration option for form workflows
According to the help page "Configure Zoho Desk integration in form workflows" we should be able to select Zoho Desk as an integration target but when I open the integrations list then Zoho Desk is not being listed in it. We are on the Premium plan which should already support Zoho Desk integrations.Gantt for 2 or more projects
Hello, I'm trying the free version of your produtc. It is veryyy good!!!! I don't know if in the Standard plan, I can overview a Gantt Graph for 2 or more Projects Milestone. This would be very helpfull for managing teams and taking decisions about who I will assign a task to. In the paid plan Do I have this possibility? Thank you.Integrating a Zoho Project Gantt Chart into Reports
Is is possible to integrate a Zoho Project Gantt Chart into a Zoho Report Dashboard. I am in the process of creating Project Status Dashboards for the projects that we track in Zoho Projects and I would like to incorporate the gantt chart within Reports. Please let me know! ThanksZOHO BOOKS - EXCESSIVELY SLOW TODAY
Dear Zoho Books This is not the first time but it seems to be 3 times per week now that the system is extremely slow. I work on Zoho Books 95% of my day so this is very frustrating. Zoho you need to do something about this. I have had my IT guy checkDisplaying related quotes in sales order and back
Hi, My colleague liked to see to which sales orders, the quote has been converted. Quote shows Invoices, but not SO. Same, they would like to see the quotes in the sales order, as they can see invoices, packages, shipment, How can we achieve this ? ThankTip of the Week #71–Auto-move incoming messages to the right inboxes with keywords
We all know that customer-facing teams, especially your sales and support teams, can’t afford to miss even a single customer conversation. But sometimes, sales queries or support requests can easily get lost in a crowded inbox or even end up in the wrongClearing Fields using MACROS?
How would I go about clearing a follow-up field date from my deals? Currently I cannot set the new value as an empty box.Migrating a Zoho Forms form into Zoho Creator
Hi, How can I migrate my Zoho Forms form into Zoho Creator? Thanks. Truly, EmadIs there any way to recall an email sent using Zoho CRM?
If an email is sent using Zoho Mail, there is a recall option/functionality that is available to the sender. Is there any way to recall an email if it was sent using Zoho CRM? I can't seem to find that option. Any help would be appreciated.Problem with reports due to "Connected" items change - Yes this IS a problem
Now that the change has been made to use "connected" items I can no longer run the reporting I need in CRM. I should be able to start with Deals as the parent, connect down to the Account (Account_Name) on the deal as the child, then to any child itemsIntroducing notifications in the vendor portal
Imagine this: You're a recruiter working with multiple vendors on a high-volume hiring project. You’ve just updated a job description after a last-minute change from the hiring manager. One of your vendors, however, is still working off the older versionCRM limit reached: only 2 subforms can be created
we recently stumbled upon a limit of 2 subforms per module. while we found a workaround on this occasion, only 2 subforms can be quite limiting in an enterprise setting. @Ishwarya SG I've read about imminent increase of other components (e.LESS_THAN_MIN_OCCURANCE - code 2945
Hi I'm trying to post a customer record to creator API and getting this error message. So cryptic. Can someone please help? Thanks VarunAnalytics for notes created
Is there a way I can see how many notes were created per day? Via reporting or analytics?Cannot update Recurring_Activity on Tasks – RRULE not accepted
Hello, I am trying to update Tasks in Zoho CRM to make them recurring yearly, but I cannot find the correct recurrence pattern or way to update the Recurring_Activity field via API or Deluge. I have tried: Sending a string like "RRULE:FREQ=YEARLY;INTERVAL=1"Add image to report...
Greetings, I send a weekly color coded report via Creator email. I would like to add the legend somewhere in the report. Header, footer where ever. I have the legend saved on Google Drive and can access it via shared link. Sure someone has wanted to addMore controls for User Fields in CRM
Dear All, We are here with a minor but crucial enhancement to the user fields—now set accessibility permissions to the records for user field. User field allows you to extend co-ownership of records to your peers. You can collaborate with them for certainCalls to accounts rather than leads or contacts?
So..... We have a dilemma and I'm hoping someone has encountered this before and figured out a fix. We have just migrated to Zoho. It's great.....expect for how "Calls" are handled.... We are B2B. We do not use the leads module. A "Lead/Prospect" forImage Upload Field | Zoho Canvas
I'm working on making a custom view for one of our team's modules. It's an image upload field (Placement Photo) that would allow our sales reps to upload a picture of the house their working on. However, I don't see that field as a opinion when buildingPower of Automation :: Automated 'Delayed & Closed' Status Update Based on Due Date
Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automateLead Blueprint transition in custom list view
Hi, Is It possible to insert the Blueprint transition label in a custom Canvas list view? I am using Lead module. I see the status, but it would be great if our users could execute the Blueprint right from the list view without having to enter the detailedRange names in Zoho Sheet are BROKEN!
Hi - you've pushed an update that has broken range names. A previously working spreadsheet now returns errors because the range names are not updating the values correctly. I've shared a video with the support desk to illustrate the problem. This spreadsheetpopulate email address and name in zoho desk?
Is it possible to populate the email address and name in the zoho desk widget? We only use it in the context of an authenticated user, so we already know the user's name and email. Thanks,Are there default/pre-built dashboards in Zoho Desk?
Hi, I am looking for some pre-built dashboard templates in Zoho Desk, similar to what we can find in CRM/Projects, etc Thank youSAP S/4 HANA to CRM Integration - change the SAP Client ID
Hi I am trying to push the business partners from SAP S/4 HANA to ZOHO CRM module. The SAP Client ID is 421 in my case....kindly let me know how do I specify the sap client because it's a dropdown with specific values as of now. Thanks Ravi AswaniAdding branded signature to tickets reply
Hi, i am unable to figure out how to add signatures with logo to tickets reply. please advice .How to share ticket numbers across different ticket types
I'm running an event and have three different ticket types. Add on Event + Main Event - Early bird Main Event only - Early bird Add on Event only - Early bird And Standard class - shown but not available until early bird finishes Add on Event + Main EventAdding Social Media Buttons to Basic Campaigns
Hi, I'm quote new to using Zoho Campaigns and I can't work out how to add Social Media Buttons into my basic campaign? In MailChimp there's a button that brings the icons into your campaign for you. I've tried adding the social media icons as 'buttons' in Zoho but it's not looking great. Can anyone help? Thanks!Hide Inactive Social Sign-In Providers from Login Screen
Hello Zoho Team, We hope you are doing well. Currently, Zoho One allows admins to configure security policies and enable or disable Social Sign-In options for third-party providers such as Apple, Google, Microsoft, LinkedIn, Yahoo, Twitter, Facebook,[Free Webinar] AI Agents in Zoho Creator - Creator Tech Connect
Hello Everyone! We welcome you all to the upcoming free webinar on the Creator Tech Connect Series. The Creator Tech Connect series is a free monthly webinar that runs for around 45 minutes. It comprises technical sessions in which we delve deep intoDownload All Attached Files
It would be extremely useful to have "download-all" functionality for downloading files attached to a task, subtask, comment, forum post or hosted in the "Documents" section etc. We've instructed our users to zip multiple files prior to uploading, but of course they forget all the time. Having to download lots of files one-at-a-time off a comment or task wastes a lot of time.Next Page