Kaizen #56 - Upsert Records #API
Hello everyone!
Welcome back to another week of Kaizen.
In this post, we will discuss the Upsert Records API.
1. The purpose of upsert records API
Using the upsert records API, you can either insert or update records in a module. When you fire an upsert call, the system checks for duplicate records based on the duplicate check field's values. If the record is already present, it gets updated. If not, the record is inserted.
2. The duplicate check fields
There are two types of duplicate check fields:
2a. The system-defined duplicate check fields
These are the default unique fields. When you upsert a record, the system checks for duplicate entries in these fields.
Module-wise system-defined duplicate check fields
Module | System-defined duplicate check field |
Leads | Email |
Accounts | Account_Name |
Contacts | Email |
Deals | Deal_Name |
Campaigns | Campaign_Name |
Cases | Subject |
Solutions | Solution_Title |
Products | Product_Name |
Vendors | Vendor_Name |
PriceBooks | Price_Book_Name |
Quotes | Subject |
SalesOrders | Subject |
PurchaseOrders | Subject |
Invoices | Subject |
2b. The user-defined unique fields
The fields for which "Do not allow duplicate values" is enabled. Click here to know more. Note that you can only set fields with the following field-types as unique— Single Line, Email, Phone, Number, Long Integer, and URL.
3. The duplicate_check_field array
You can set the order in which the system checks for duplicate records by specifying the duplicate_check_field array in the input. You can add only the system-defined duplicate check fields and user-defined unique fields to the duplicate_check_field array. For instance, in the example below, "Email" is the system-defined duplicate check field, and "Phone" and "Fax" are the user-defined unique fields for the Leads module.
"duplicate_check_fields": [ "Email", "Phone", "Fax" ] |
If you do not specify the duplicate_check_field array, the system checks for duplicate records in the following order:
- System-defined duplicate check fields
- User-defined unique fields
4. How does duplicate check work?
Consider a case where the user has configured two unique fields unique1 and unique2 for a module (user-defined unique fields), and Email is a system-defined unique field.
The following table explains how the duplicate check happens for different user inputs to the duplicate_check_fields array.
User Input to the "duplicate_check_fields" Array | Duplicate Check Order |
unique1 | unique1, unique2 |
unique2 | unique2, unique1 |
unique1, unique2 | unique1, unique2 |
Email | Email, unique1, unique2 |
No input | System-defined duplicate check field for that module followed by unique fields. That is, Email, unique1, unique2 |
If you do not specify the system-defined duplicate check fields in the array, the system will ignore them and check only for user-defined unique fields.
5. Upserting a record via API
OAuth Scope
The scope to access the Deals module via API is:
ZohoCRM.modules.{module_api_name}.{operation_type}
ZohoCRM.modules.{module_api_name}.{operation_type}
The operation type can be ALL, WRITE, or CREATE.
Click here to know more about the scopes.
Request URL: {{api-domain}}/crm/v2/Leads/upsert
Request Method: POST
Sample Input
{ "data": [ { "Last_Name": "Frey (Sample)", "Email": "frey@sample.com", "Company": "abc", "Lead_Status": "Contacted" }, { "Last_Name": "New Lead", "First_Name": "CRM Lead", "Email": "newlead@zoho.com", "Lead_Status": "Attempted to Contact", "Mobile": "7685635434" } ], "duplicate_check_fields": [ "Email", "Mobile" ] } |
Sample Response
Note:
You can insert or update a maximum of 100 records per API call.
We hope you found this post useful.
Write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
Cheers!
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
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
Sneha Sridharan
Sticky Posts
Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #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 are
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
User Name in Zoho Cliq Not Updating Across Apps?
We updated the name of a user in Zoho. (From Sue to Taylor) Her name has not been updated in Cliq on all apps. When in Zoho One, if I go to Cliq directly, it is correct, but if I am in another app, and the Cliq bar pops up on the bottom, it will be theText on Zoho Sign confirmation dialouge is very small compared to text used everywhere else on Zoho Sign.
I've reported multiple times through Zoho's support email that the text on this notification is very small in contrast to all the other text on the Zoho Sign app. I think it's a bug and it just needs the font size to be increased. It's very minor butCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsZoho CRM custom button function, how to add line breaks/ new lines in the return message
When creating button function in CRM it requires a `return "";` Then when the button is client by the user a message pops up with what ever is returned from the function. But I want to have a message with multiple lines, meaning I need to add a line breakFeature Request: Dynamic Date Filter Criteria
Please implement the ability to select a dynamic date for all Filter Criteria. This would be helpful to create views that don't constantly need to be updated (example custom date field on an account) Examples: - Today - Tomorrow - This week - This MonthSalesIQ's Summer '26 Release: For The Moments That Matter
Every customer journey is made up of moments. The moment someone discovers your business. The moment they need help. The moment you decide to reach out. The moment a simple chat turns into something more. And the moments that continue long after the conversationThere is no link between Deals and Projects in Analytics
Hello there, I am trying to link Deals with Projects in a Pivot view on Zoho Analytics. However, there is no relationship, yet on CRM there is a relationship. As you can see below, there is no link between them: However, on CRM, if you go into a Deal,How to Access Zoho Mail Messages to Microsoft Outlook? - Zoho Mail Converter
Zoho Mail is the free email hosting service which provide mailing with CRM service, so if you are one of them who is trying to import Zoho Mail emails to Outlook then keep reading. In this article we are going to provide accurate solution that will help you to import Zoho Mail emails to Outlook format in Batch. Zoho Mail service provide option to export mailbox in Zip format. So first – Export Zoho Mail emails in Zip format later use Zoho Mail to Outlook Converter to migrate Zoho emails into PSTZoho Cliq REST APIs v3 : A complete guide to what's changed and why
APIs are not just consumed by a developer with numerous automations and a series of open browser tabs. They are parsed by LLMs, fed into agent pipelines, and auto-completed by AI coding assistants that have zero tolerance for inconsistency. A verb tuckedFeature Request: Include Creator-applicable Deluge updates in the Creator Release Notes
I'd like to put forward a suggestion about how Deluge updates are surfaced to Zoho Creator developers, and I'm hoping the Creator team will consider it. Zoho Creator is built on Deluge. Every workflow, custom function, validation and schedule we writeZoho CRM Reports Module on Mobil App
I have the mobile app and the reports module doesn't appear in the sidebar for some reason. I saw a Youtube video where the user had the Reports module on mobile. Is there a setting to show it on mobile? Thanks.Introducing parent-child ticketing in Zoho Desk [Early access]
Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-childSigma function call hangs forever from Desk widget — app_install_id/encapiKey are null
Calling ZOHODESK.request() from the widget to invoke a Sigma DRE function URL hangs forever (never resolves, never rejects, no error) until client timeout. Tried with merge fields app_install_id={{sigmaInstallId}}/{{installationId}} and encapiKey={{enCapApiKey}}Workdrive on Android - Gallery Photo Backups
Hello, Is there any way of backing up the photos on my android phone directly to a specific folder on Workdrive? Assuming i have the workdrive app installed on the phone in question. EmmaAuto sync Photo storage
Hello I am new to Zoho Workdrive and was wondering if the is a way of automatically syncing photos on my Android phone to my workdrive as want to move away from Google? ThanksPostcode problems
So we were very pleased to see we could limit shipping with postcodes. Brilliant. Unfortunately we have discovered It does not seem fit for purpose. In the UK we write postcodes in various ways Examples BH217NL BH21 7NL Bh217nl bh217NL and many more waysGetting Notifications but unable to load email
I am getting notifications through the web browser and my phone app that i am receiving emails, but i can not open the email to view. Below is the screen shot of the console panel.WORKFLOW ISSUE: Zoho Finance Extension
Workflows are no longer triggering in my extension. This is true for the testing environment and 5 other organizations it is installed on. There are no conditions set for the workflow, and this is true for both create and delete related actions. WorkflowsZoho CRM Layout Rules: Nine New Actions, Profile-Based Execution, and Interactive Preview
Hello everyone, Availability: This feature is now available for customers in the JP and SA DCs. It is planned to be released for other customers in soon. We’re excited to announce powerful new enhancements to Layout Rules in Zoho CRM - a feature builtCertain items certain shipping
Me again it would be helpful to have different shipping for different categories. Our example are salt. Delivery is free but have a minimum delivery. Pickup is cheaper so it has its own category- pickup.Zia Agents looks promising, but I still cannot deploy my first agent or connect WhatsApp after weeks of support tickets
Hi Everyone, I am posting here because I am stuck and need practical help from someone who has successfully deployed a Zia Agent with WhatsApp. Zia Agents looks like a very promising product. I have watched the platform expand quickly, and I have noticedHandling Hard Bounce Contacts with Active Phone-Based Users (WhatsApp Use Case)
In Zoho Marketing Automation, when a contact is marked as “Hard Bounce”, we noticed that the contact stops receiving updates from CRM fields and may be excluded from automations. Is this expected behavior? In our case, the primary identifier and verifiedIntegration with existing websites
So most companies have existing websites. They want to integrate an online store with their existing site. How is that possible in zoho commerce please.Subject: Message bar - reducing height and adding scrolling/rotating messages
Hello Zoho Commerce Support, I am building my store (Moksha Collections) and have the Message Bar enabled and positioned at the top. I have two questions: 1. Height: Is there a native setting to reduce the height (thickness) of the message bar? It currentlyMoving over to commerce but shipping
In our company we love zoho onebut currently use ECWID for our online shop which is annoying as it requires double entering invoices. our requirements are that we do local deliveries limited by postcode -these are free. we also allow pickup they get aWebsite not properly connecting with Zoho Creator app portal (embed & data sync issue)
Hello Zoho Community, I’m currently facing an issue while trying to connect my external website with a Zoho Creator app portal. I have a tool-based website ( https://mygardencalculator.com/ ) where users interact with calculators and dynamic content.Show current inventory in the item list table for a composite item
Hello. We have many products that are composite items. Quickly determining inventory levels of individual items that make up a composite item would be beneficial. IDEA: Add columns"current inventory" and "available inventory" to the item table of theIncrease the "Maximum Saved Entries per User" Options Limit
Hi, You can create lots of saved entries, yet the Limit when you apply one is 25, we may often expect 32 to be in draft, and therefore want to enforce that, can we increase the limit of this field from 25 to 100 (As you can just turn it off and have moreWhen Zoho Tables Beta will be open to EU data center
Hello all, We in EU are looking at you all using and testing and are getting jealous :) When we will be able to get into the beta also? We don't mind testing and playing with beta software. Thank you!Deluge Editor Code Reformatting and Dark Mode Support in Zoho Creator
Hello Zoho Creator Support Team, I’m enjoying Zoho Creator but facing an issue with the Deluge editor—it's automatically reformatting my code (removing spaces, changing brace placement). Is there a way to turn this off? Also, is there any option to enableWorkflow Preventing others from editing
Using workflows in WorkDrive to implement a document review process has been extremely helpful in my organization. The only problem is that other users who have access to the document via standard document sharing rules are unable to edit the document.Add @Mention Notifications in Zoho Cliq for Zoho Project Mentions
Hello Zoho Projects Team, We hope you are doing well. We would like to submit a feature request regarding "Projects Bot" Cliq bot notifications for @mentions inside Zoho Projects comments (Tasks and Issues). Current Behavior: At the moment, when someoneCanvases Auto-Skewing/Adding Scroll Bars When They Were Not There Prior
Is anyone else noticing rendering issues in their canvases today? It seems to be mainly icons which now have scroll bars added which makes them all look off, though some fields seemed to revert to squished length as well. Were the icons replaced withHow to see exact clicked links in CRM from Zoho Campaigns ?
Hi, I'm wondering how I can see the clicked links from an email sent from Campaigns when I'm in a campaign in the CRM module. I can see the number of clicks but I need the sales team to be able to see which link has been clicked by a prospect or contact.Allow native Webhooks to authenticate via Connections
Allow native Webhooks to authenticate via Connections (Basic Auth) instead of plaintext custom headers Summary Please allow native Webhooks (Workflow Rules > Instant Actions > Webhooks) to authenticate against the destination endpoint using the existingImprove your booking page visibility with SEO settings
We're excited to introduce SEO settings, helping you optimize how your booking pages appear in search engines and reach more customers organically. SEO settings are available for all booking page types: Business, Workspace, Event Type, and User. WithRelated List Expanded View in Zoho CRM: see more related records at a glance, filter and take bulk actions
Hello everyone! Related lists show you the records connected to what you're working on: contacts under an account, activities tied to a deal, products linked to a quote. But until now, you could only see 10 records at a time. If you needed to filter resultsKaizen #250: Introducing write-enabled Queries: Auto-populating lookup fields during Kiosk-driven Blueprint transitions
Hello Everyone, Welcome back to an exceptional edition of the Kaizen series! Today marks Kaizen #250, an exciting milestone in our journey of exploring, learning, and building with Zoho CRM. Over the past 249 editions, we've covered a wide range of features,Does anyone else wish you could download Mail Merge quotations from the Zoho CRM mobile app?
Is it just me, or has anyone else run into this? I’m in sales, so I’m rarely at my desk. I’m usually in meetings, visiting clients, or travelling. One thing that genuinely frustrates me is that if a client asks me for a quotation, I can’t generate orHow to automatically update a % field according to a dropdown field in the Quote table
Hello there, I have following couples: Success % Status 0% NP 30% No Feedback 50% PR 80% Opp. Concreta 100% A I would like the Success % field (percent) to automatically update based on the item of the Status field (dropdown). The fields are within theNext Page