ZOHO CRM Sandbox Environment and API Calls
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
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
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achieved
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns 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
Wrong Time on Exported Records
Hello, All records in my exported Notes .csv file have the incorrect time for Created Time. They are all 8 hours ahead. I've already verified that my time zone is correct in both Personal Settings and Company Settings. Is there any way to fix this?how to upload the picture and document
i want to upload the picture and document,would you please told how to upload them?could you told it for each step?Zia Call Intelligence only up 10 License
I have been trying to install Call Intelligence for two days now, but strangely, the button is missing at this point. The documentation could be better, but most importantly, someone should inform small businesses like us that they don’t even bother enablingForgot my email management account
Hello, I am the administrator of ihomemix.com. I can’t remember which email address I used to register the account and then opened the email service for ihomemix. I can’t see the subscription period of my email function when I log in with this account.Add customer to account based on domain name.
I generate reports based on a the account field, i.e. companyX. In GoToAssist, my last provider, there was an option to automatically assign new ticket creators to a company (or account) based on their domain name. So for example, if a new employee creates a ticket from @companyx.com, for them to be automatically added to the companyx account would be a huge advantage. As it stands right now, I have to remember to add them to the account manually. Often I forget and when generating a report forFacilitate business processes by mandating Kiosks in your Blueprint's transition settings
Hello everyone, We've made a few enhancements to Kiosk Studio. Blueprints provide a structured and systematic approach to executing business processes, and you can use Kiosks to build custom capabilities to retrieve, collect, and execute actions on CRMResponse Violation - Zoho Desk
Hi Team, I just need an information regarding the zoho desk - Response Violation and how can we avoid the tickets from getting the tickets response violated.I need help in setting up a script that works for my calling service
Please i need your guidance and expertise in how to go about a particular scripting. You see, we are a call service that assists companies to receive calls for them, i need to create a system in my Zoho CRM whereby i will receive call from my already"Select All" item in the context menu
In the Client on Android, there is a “Select all” item in the note’s context menu. There is no such item in the PC client. Can it be added in future versions of the client?Subir o Preço Unitário já acrescido de um valor
To com um desafio grande, e se alguém conseguir me ajudar, seria ótimo! O que eu preciso é que o na hora de adicionar um item no subformulário dos itens cotados do módulo Orçamentos, o preço de lista do item venha acrescido de 20% automaticamente e deZoho CRM Customer Portal Pricing Question
Hello, I am trying to find out about the pricing for a portal that will be used for the contacts and a custom module. My client needs to use a customer portal for 15k users that will display the contact details and some informations to a linked customHow to display Motivator components in Zoho CRM home page ?
Hello, I created KPI's, games and so but I want to be able to see my KPI's and my tasks at the same time. Is this possible to display Motivator components in Zoho CRM home page ? Has someone any idea ? Thanks for your help.Zoho developer edition does not work for us
Hi Is anyone else having this problem? I'm signed in with our admin/super user account. When I click on the link on this page: https://www.zoho.com/crm/developer/docs/dev-edition.html I am asked to agree to Terms and Conditions. Clicking Agree to Termsis zoho CRM down today ?
Is zoho CRM down today ?Export email adresses to email service provider (mailchimp or other)
Hello, Is there a way to export a list of email adresses from a search in my Zoho Creator forms to an external email service (gmail, yahoo...) and initiate at the same time an email message that I will fill and send myself ? And what about Mailchimp,is it possible to add more than one Whatsapp Phone Number to be integrated to Zoho CRM?
so I have successfully added one Whatsapp number like this from this User Interface it seems I can't add a new Whatsapp Number. I need to add a new Whatsapp Number so I can control the lead assignment if a chat sent to Whatsapp Phone Number 1 then assignProblem viewing document imported from google drive.
Hello, When I add a document via my google drive, it is impossible to preview it. I get the error “Files without extensions cannot be previewed. Download to view this file”. Could you please help me? Also, and this is more of a question: is there a wayLaunch Blueprint or Workflow Automation via Zoho Dataprep Import
Greetings All, I'm curious - Is it possible to trigger a Blueprint or Workflow via Data Prep import? Thanks in AdvanceCross module filtering is now supported in CRM
Editions: All DCs: All Release plan: This enhancement is being released in phases. It is now available in AU, JP, and CN DCs. Help resource: Advanced filters While the feature is being released in phases, you can also request for Early Access. Early AccessPosibility to add Emoticons on the Email Subject of Templates
Hi I´ve tried to add Emoticons on the Subject line of Email templates, the emoticon image does show up before saving the template or if I add the Emoticon while sending an Individual email and placing it manually on the subject line. Emoticons also showBulk Delete Customer Contacts.
Due to a config issue on my end (my fault), I have ALL contacts from CRM imported as contacts in Books. Some clients have 30+ contacts. Is there a funky way to bulk delete? Each contact has three clicks and a scroll to delete them.Multiple domains for same username and password
I've come across this situation the vault is currently suggessting the passwords autofill option by the domain. wondering whether is there any option to save one password for multiple domains since the microsoft login has two domains https://login.microsoftonline.com/Introducing Bot Filtering for Accurate Email Campaign Analytics
Dear Marketers, We're excited to announce a new feature designed to enhance the accuracy of your email campaign analytics: bot filtering. This feature helps you filter out bot-generated opens and clicks, ensuring your campaign reports reflect genuineOption to specify or disable "Idle" times in preferences
It seems strange to me that my Cliq shows me as "Idle" when I'm using the PC and available just because I haven't interacted with Cliq in a while. I'm far from "Idle" so we're just treating "Idle" and "Available" to mean the same thing. I'd like to suggest a setting to change the timeout or even disable the automatic "Idle" mode.Link project tasks to tasks in CRM and/or other modules.
Hello, I have created and configured a project in Zoho Projects with a set of tasks. I would now like to link these tasks (I imagine according to the ID of each one) to actions in the CRM: meetings, tasks, analytics). The aim is to link project tasksFunction #61: Automatically add free item to the invoice based on item quantity
Hello everyone, and welcome back to another Custom Function Friday! During holiday seasons or special promotions, businesses offer deals like BOGO (Buy One, Get One), Buy 3 Get 1 Free, Buy 2 at 50% off, and much more to attract customers. These promotionsRegarding GST Report Issue in Zoho Books
Hi, Right now, the very important point from my end is this Zoho Books issue. Here, you can see that we have created the invoice with the items of account sales and expenses. The journal is also correct. The profit and Loss statement is also correct.Multiple Salesperson against an invoice
Hello, Against a particular invoice, we have multiple sales people working. The reason we combine the invoice is becuase we are an exporter and often consolidate cargo for our customer to save them freight costs. How do I capture the contribution of eachProjectwise budget ---
Can we have a Project wise subject in addition to the Monthly, and quarterly ACCOUNT LEVEL budget?Looking back at Zoho Social's 2024: Highlights and memories
Hey everyone, We hope you had a relaxing and joyous holiday season. Whether you're planning for the new year or still soaking in the magic of the season, we're here to share some exciting highlights from 2024 – a year that was fully packed with updatesBIN Locations
Hi, I’m new to Zoho inventory and unless Im missing something, I cannot find BIN locations anywhere in ‘items’? please tell me it’s there somewhere?!? ThanksBuilding a Zoho Extension for Webex CC - Handling URL Changes
Hi everyone, I’m building a Zoho extension for Webex Contact Center (Webex CC) and facing an issue with handling URL changes. In telephony, I’ve set the URL of Webex CC to: https://desktop.wxcc-us1.cisco.com/ When this URL remains the same, everythingRemove County field from Customer Address input screen (or allow input to be deleted)
We are in the USA and have just noticed that there is now a County field in the Customer Address input screen (and maybe other areas of Zoho Books, but this is the one affecting us at the moment). County is not important to our business, and in fact weBigin API Token Request ("invalid_client")
Hi people, I tried to connect to the API without success, I've read all of the documentation multiple time and tried just about everything. I tried to do it with Python Request module and with Postman, passing the information through both the URL parameterHow to add a Data Updated As Of: dynamically in text?
I need to add a "Data Updated As Of" in the dashboard to show when was the last date the data was updated. I tried to create a widget but it does not look really good, see below. Is there a way I can do this through the text widget and update it automaticallyShared Dashboard / Report Permissions : Read not Write
hi all, We are missing a huge fonctionnalite in setting up Dashboards (and reports) on corporate level. Currently, we can not set Read Permissions on share Dashboards (and reports) without giving write access as well When we create a corporate dashboardTrying to catch error with ZOHO.CRM.HTTP.get (Response Code)
Hello, I'm trying to get response header from ZOHO.CRM.HTTP.get, in order to catch error like 404 or something else but it seems that ZOHO.CRM.HTTP.get() method only returns the body of the response, and I see no way to access the headers returned. IsProfile stitching with Zoho Marketing Automation
When it comes to marketing, knowing who your audience is and tracking their interactions is vital. That's why Zoho Marketing Automation has taken a significant leap forward with its enhanced profile stitching feature. With this update, you can track yourGDPR
Hi , I'm checking out the HIPPA capabilities and at the moment I can see only three modules that can be selected to enable HIPPA Any idea how I can add additional modules such as customers? TNX Daviddefault task list for new project
Is there any way to have a default task list already created in a project, when the project is created in Zoho Books?Next Page