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
Send a campaign to one recipient.
Very often I speak to a customer and they say they didn't see my email (maybe it went in Junk, maybe they deleted it). Anyway, I just want to go into the Campaign and send it to one person. You already have a feature very close to this - when sending a Test. While developing a campaign, I can send tests to anyone. Why can't we have this AFTER the campaign has been sent? I know, there's a caveat, and that's in the use of merge tags. Most of the time I only use FNAME, but maybe you could check ifTry FSM again for our business
We already have our customers individual equipment in CRM with serial numbers, install dates, warranty length and importantly next service which is generally 2 years. a month before the service date is due we get get a report and send out service reminders.Get Cliq Meetings in my O365 calendar
Hi, we are currently evaluating to replace the Teams Messaging and Meetings with Cliq. We currently still have all our email and calendars in O365. What i want to achieve is, to create a (ZOHO) meeting from Cliq and have this meeting added to my Outlook/O365Issue with Zoho Help Portal – Tickets Missing or Not Answered
Hi, How are you? I think there may be an issue with the Zoho Help Portal. I opened a few tickets directly in the help portal a some time ago but never received any response I also opened ticket 148356451 by email. I did receive a reply to it, but theDUNS & Bradstreet and Credit risk monitoring integration with Zoho books
Small businesses not being paid by bigger clients and clients of all sizes is a huge problem. It will be nice if Zoho develops integration with DUNS & Bradstreet(D&B) and Credit risk monitoring integration with Zoho books. That have small businesses canZoho Forms - Form Rules based on attachment fields
Many businesses use forms to collect documents and images from customers. In many cases, you may want to trigger a notification or other automation based on whether or not an attachment was added. I've noticed that attachment fields do not appear in RulesCan't open draft email for editing
Last night I started composing an email and I let it save in drafts. This morning I want to continue working on the email. It is in my Drafts folder but it will not open. The only option there is to delete it. This is not the first time it has happened. On previous occasions I have just deleted the draft and started afresh, but I really want this one back. Windows 10 with Pale Moon 28.10.0 browser.Open filtered deals from campaign
Do you think a feature like this would be feasible? Say you are seeing campaign "XYZ" in CRM. The campaign has a related list of deals. If you want to see the related deals in a deal view, you should navigate to the Deals module, open the campaign filter,Change scheduling emails time
When sending an individual email there is a great feature to schedule them to send later. I could only use the one time that is suggested. Is there a way to select another time? Regards, GlennZoho CRM: how can I control which contacts to sync with Outlook?
I was just playing around syncing contacts from Zoho to MS Outlook (MS365 account.) The problem is our firm has hundreds of thousands of contacts and I don't want to bury my contacts list in outlook. Any help with this is greatly appreciated.How to overcome limitations in meetings
As a company, one of our deliverables is a meeting between two other companies, where we act as facilitators. So, if we recorded this meeting in Zoho CRM, it should be connected to 2 accounts, 2 contacts, and 1 campaign (a campaign, in our use, is theAdd a 'Log a Call' link to three dot icon in Canvas
Hi, There's a three dot element when creating a canvas called 'More'. I would like to modify this to add a link that says 'Log a Call' in order to quickly record the details of a cellphone call. I'd also like this to be a simple 'contact' selection andSyncing Zoho Forms with Bigin - Embedding issue?
Hello everyone, I created a Zoho Form for a page on my GoDaddy website to collect leads, which then transfers the data to Bigin. However, I'm facing an issue where it doesn't seem to work properly. I've integrated Zoho Forms with Bigin and tried embeddingCan not add fields to a Section
I feel like I'm missing something obvious: I can add new Sections to my form but I can not add fields to the Sections. I've tried fields already on the form as well as dragging and dropping new fields into the Section but nothing will go into it. WhatRecord Logged in User while using CRM lookup field
Is it possible, while using the Zoho CRM lookup field, to automatically use the user account logged into Zoho CRM in a hidden field? I was hoping to add employee accounts to my current plan. But would like a record on the Form submission of who submittedForm Rules for Suburb Categories to alternate landing pages or Making a Fields Contents ALL CAPS
I need to send differentform submissions to two to three different thank-you URLs (for Meta/Google pixels) depending on which suburb a user selects in a form. I have ~400 suburbs split into two categories (A and B, based on business value). Current challenges:Collaps Notes
There are times when long/large notes are added to a record i.e. Accounts or Deals etc. Currently, the full note is displayed in the notes related list section. It would be great if by default only 5 to 10 rows of the note are displayed when the noteZoho Down
I have a drop in my Zoho One services.Runing RPA Agents on Headless Windows 11 Machines
Has anyone tried this? Anything to be aware of regarding screen resolution?Problem for EU users connecting Zoho CRM through Google Ads for Enhanced conversions
Has anyone else experienced this problem when trying to connect Zoho CRM through Google Ads interface to setup enhanced conversions? Did you guys get it fixed somehow? The Problem: The current Google Ads integration is hardcoded to use Zoho's US authenticationWhy am I getting event Pop-up Notification for events that have been cancelled?
Why is Calendar Notification still popping up for events that have been cancelled or changed? Each time events are cancelled or changed, I have observed that I am still getting notifications for them. Below is a sample pop-up notification for one of theCreate a draft in reply to an email via Emails API
Hi, I’d like to use the outgoing webhook to automatically create a draft reply to incoming mail. How can I use the Emails API to create a draft reply that is linked to an existing email thread? I couldn’t find the relevant method in the documentation.India Tech Support
Is there no phone tech support number for India? And no chat facility either?Billing Management: #1 Billing a Universal Business Routine
Hello, As the saying goes, "Do the hardest job first." We started with the complex subject of finance and revenue management, which is considered the backbone of any business. Now, let's shift our focus and take a deep dive into this Billing Management,What is a a valid JavaScript Domain URI when creating a client-based application using the Zoho API console?
No idea what this is. Can't see what it is explained anywhere.5名限定 課題解決型ワークショップイベント Zoho ワークアウト開催のお知らせ (9/25)
ユーザーの皆さま、こんにちは。Zoho ユーザーコミュニティチームの藤澤です。 9月開催のZoho ワークアウトについてお知らせします。 今回はZoomにて、オンライン開催します。 諸事情につき、今月の開催回は中止となりました。 次回は10/31（金）14時からの開催を予定しています。 ━━━━━━━━━━━━━━━━━━━━━━━━ Zoho ワークアウトとは？ Zoho ユーザー同士で交流しながら、サービスに関する疑問や不明点の解消を目的とした「Zoho ワークアウト」を開催します。 Zohoneed a packing list feature
In our business, goods listed on an invoice are packed in separate boxes and shipped off. for e.g. an invoice may have 10 items. each item could then be packed in different boxes depending on qty of each item. this packing list is as important as the invoice for purposes of shipping documents. Request you to add this feature asap.Workdrive 5.0 / API Documentation Workflows
Hi Zoho, When will the API documentation of the workflows be published? We are interested in using it to trigger manual workflows from an external application. Greetings, JustinHow many ZOHO-Sites does the ZOHO-One Suite allow for?
The free version of ZOHO-Sites allows for two sites, but it seems that the professional version (which is included in the ZOHO-One Suite) only allows for two websites. Is that correct? How many sites can I have within one ZOHO-One account?Webhook from Zobot to Zoho Flow fails
I'm trying to connect from zobot to zoho flow. When testing in zflow, I am receiving all entered data from the connector correctly. The SalesIQ connector's "outputreaction" is {} (is this normal or is there a problem?). But as soon as I try my chat botTransition from Sole Proprietorship to GmbH (Limited Liability Company) – Best Approach in Zoho Books / Zoho One
Hello everyone, I am currently operating under a Zoho One plan with a sole proprietorship in Switzerland. As of January 1st, 2026, I will be incorporating a new legal entity – a GmbH (Swiss equivalent of a Limited Liability Company). While the businessIssue Connecting My Domain to Zoho Sites Despite Purchasing It from Zoho
Hello, I am facing an issue connecting my domain to my website on Zoho Sites. Details of the issue: I purchased the domain directly from Zoho. I am already using the same domain successfully with Zoho Mail. However, when I try to assign this domain toInsert auto number from main form into subform rows
Hello. I'm trying to take from my main form "order number" which i have setup as an auto generated number into every line created in my subform. So when a row is created in my subform i want the "order number " from the main form to be inserted automatically.Dark Mode - Font Colors Don't Work
When editing a document in Dark Mode and selecting font colors, they don't show up on screen. Viewing/editing the same document in Light Mode shows them just fine.Integrate Bunq with ZOHO Bookes
We are new users of ZOHO Books, and our bank (BUNQ, in the Netherlands) isn't listed on the bank integrations. Is there a way to handle this?Access Denied
I am iOS Developer and updating our clients project and shifted ZohoDeskPortalCore SDKs from cocoapods to SPM and changed few lines of code but now i am get access denied, the help center app is unavailable. please contact administrator.Using Zoho Desk to support ISMS process
Hi, I am evaluating using Zoho Desk for security incident management. This seems to be aligned with Zoho Desk purpose as its just another type of incident. However in security incident management, ideally I can link incidents (tickets) with a risk fromTaxJar vs Avalara
Hi, I'm evaluating adoption of a sales-tax service for US based business. Anyone else have experience with TaxJar and Zoho Books? I am a Zoho One subscriber so anticipate needing to use Flow to make this work. It seems like Avalara are simply too expensiveHow to check Leads with no Task (open activity)
Hi everyone, I was wondering if there’s a way to view leads that don’t have any tasks assigned or open activities linked to them.What can we do on our end to improve the Answer bot answers?
Hi, I'm using the Answer bot card in the Codeless bot builder. I've input several questions and their answers in the FAQ section to feed the Answer bot. The text is all in French, as this is the language our customers communicate in. I've tried testingNext Page