Kaizen #32 - Handling Custom Modules with Zoho CRM #API
Hello everyone!
Welcome back to another post in the Kaizen series.
This week we are going to dive deep in exploring the custom modules and the possible operations that you can perform in API with them.
Zoho CRM offers more than ten standard modules for different purposes like Sales, Marketing, and so on. However, in some scenarios, they do not satisfy the requirements. In such cases, Zoho CRM lets you create custom modules to meet your business needs..
In this post, we will discuss the following things related to a custom module:
1. Insert a record
2. a) Update multiple records
b) Update a specific record
3. a) View all the records
b) View a specific record
4. a) Delete multiple records
b) Delete a specific record
5. Upload an attachment
We will be considering the 'Student' module as our custom module, and hence all the input samples and responses will be about the student module. The fields in our Students module are:
S.No. | Field Label | Data Type |
1 | Attendance | Percent |
2 | Created By | Single Line |
3 | Email | Email |
4 | Email Opt Out | Boolean |
5 | Marks | Number |
6 | Modified By | Single Line |
7 | Phone | Phone |
8 | Secondary Email | Email |
| 9 | Student Image | Student Image |
10 | Student Name | Single Line |
11 | Student Owner | Lookup |
The following image gives an overview about the Web UI of our custom module.
1. Insert a record in the Custom Module
We begin with discussing how to insert a record in the custom module. The procedure is similar to that of inserting a record in any standard module. We need the api_name of our custom module. We use the modules API that lists all the modules available in our org to fetch the. We then need to search for the name of our custom module. The value of the key "api_name" gives the API name of your custom module. In our case, the custom_module_API_name is "students."
Request URL : {{api-domain}}/crm/v2/{custom_module_API_name}
Request Method : POST
Sample URL : {{api-domain}}/crm/v2/students
Sample Request Body :
{ "data": [ { "Name": "Jack", "Phone": "9876543210", "Attendance": 87, "Marks":90, "Owner": { "name": "Patricia Boyle", "id": "3719520000000191015", "email": "patricia.boyle@zohocorp.com" } } ] } |
Sample Response:
{ "data": [ { "code": "SUCCESS", "details": { "Modified_Time": "2020-04-30T12:35:34+05:30", "Modified_By": { "name": "Patricia Boyle", "id": "3719520000000191015" }, "Created_Time": "2020-04-30T12:35:34+05:30", "id": "3719520000000711023", "Created_By": { "name": "Patricia Boyle", "id": "3719520000000191015" } }, "message": "record added", "status": "success" } ] } |
2a. Update a specific record in the Custom Module
In this section, we will update a specific record in the Custom Module. The procedure is similar to Update a Specific Record API that we use for any Standard Module. We will be requiring record_id of the specific record that we are going to update.The ids of the records can be retrieved from Get Records API.
Request URL : {{api-domain}}/crm/v2/{custom_module_API_name}/{record_id}
Request Method : PUT
Sample URL: {{api-domain}}/crm/v2/students/3719520000000711016
Sample Request Body:
{ "data": [ { "Name": "Jackson", "Phone": "9876543212", "Email": "jack.geller@zohocorp.com", "Attendance": 89, "Marks": 90 } ] } |
Sample Response:
{ "data": [ { "code": "SUCCESS", "details": { "Modified_Time": "2020-04-30T13:48:26+05:30", "Modified_By": { "name": "Patricia Boyle", "id": "3719520000000191015" }, "Created_Time": "2020-04-30T12:29:45+05:30", "id": "3719520000000711016", "Created_By": { "name": "Patricia Boyle", "id": "3719520000000191015" } }, "message": "record updated", "status": "success" } ] } |
2b. Update multiple records in Custom Module
In this section, we will update multiple records in a custom module. We use Update Records API to update multiple records in the custom module. We must specify the IDs of the records along with data of those records that we want to update in the input body.The records can be fetched using Get Records API.
Request URL : {{api-domain}}/crm/v2/{custom_module_API_name}
Request Method : PUT
Sample URL: {{api-domain}}/crm/v2/students
Sample Request Body:
{ "data": [ { "id": "3719520000000711016", "Attendance": 95 }, { "id": "3719520000000711023", "Attendance": 89 } ] } |
Sample Response:
{ "data": [ { "code": "SUCCESS", "details": { "Modified_Time": "2020-04-30T13:44:44+05:30", "Modified_By": { "name": "Patricia Boyle", "id": "3719520000000191015" }, "Created_Time": "2020-04-30T12:29:45+05:30", "id": "3719520000000711016", "Created_By": { "name": "Patricia Boyle", "id": "3719520000000191015" } }, "message": "record updated", "status": "success" }, { "code": "SUCCESS", "details": { "Modified_Time": "2020-04-30T13:44:44+05:30", "Modified_By": { "name": "Patricia Boyle", "id": "3719520000000191015" }, "Created_Time": "2020-04-30T12:35:34+05:30", "id": "3719520000000711023", "Created_By": { "name": "Patricia Boyle", "id": "3719520000000191015" } }, "message": "record updated", "status": "success" } ] } |
3a. View all the records in the Custom Module
In this section, we will retrieve all the records in a custom module. The procedure is similar to that of listing all the records in any standard module.
Request URL : {{api-domain}}/crm/v2/{custom_module_API_name}
Request Method : GET
Sample URL : {{api-domain}}/crm/v2/students
Sample Response:
3b. View a specific record from the Custom Module
In this section, we will retrieve the details of a specific record in the custom module.We will be requiring record_id of the specific record that we want to view.The ids of the records can be retrieved from Get Records API.
Request URL: {{api-domain}}/crm/v2/{custom_module_API_name}/{record_id}
Request Method: GET
Sample URL: {{api-domain}}/crm/v2/students/3719520000000711023
Sample Response:
4a. Delete multiple records from the Custom Module
In this section, we will delete multiple records from the custom module. We must specify the ids of the records to be deleted. The ids of the records can be retrieved from Get Records API.
Request URL : {{api-domain}}/crm/v2/{custom_module_API_name}?ids={record_ids separated by commas}
Request Method : DELETE
Sample URL : {{api-domain}}/crm/v2/students?ids=3719520000000711016,3719520000000711004
Sample Response:
{ "data": [ { "code": "SUCCESS", "details": { "id": "3719520000000711016" }, "message": "record deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "3719520000000711004" }, "message": "record deleted", "status": "success" } ] } |
4b. Delete a specific record from the Custom Module
In this section, we will discuss deleting a specific record from the custom module.We must specify the record_id of the records to be deleted. The id of the record can be retrieved from Get Records API.
Request URL : {{api-domain}}/crm/v2/{custom_module_name}/{record_id}
Request Method : DELETE
Sample URL : {{api-domain}}/crm/v2/students/3719520000000711044
Sample Response:
{ "data": [ { "code": "SUCCESS", "details": { "id": "3719520000000711044" }, "message": "record deleted", "status": "success" } ] } |
5. Uploading an attachment to the Custom Module
In this section, we will upload an attachment to the custom module. Specify the record_id to which the attachment needs to be added. The id of the record can be fetched from Get Records API.
Request URL : {{api-domain}}/crm/v2/{custom_module_name}/{record_id}/Attachments
Request Method : POST
Sample URL : {{api-domain}}/crm/v2/students/3719520000000722003/Attachments
Note : Add the file to be uploaded as a multi-part file.
Sample Response:
We hope you found this post useful. Keep a tab on this series for more exciting topics!
Reach out 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
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
Srivathsan N V
Sticky Posts
Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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 #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.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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.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! Commands
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
I'd like to suggest a feature enhancement for SalesIQ that would greatly improve the user experience across different channels.
Hello Zoho Team, Current Limitation: When I enable the pre-chat form under Brands > Flow Controls to collect the visitor’s name and email, it gets applied globally across all channels, including WhatsApp, Messenger, and Instagram. This doesn't quite alignEnhance Barcode/QR Code scanner with bulk scanning or continuously scanning
Dear Zoho Creator, As we all know, after each scan, the scanning frame closes. Imagine having 100 items; we would need to tap 100 times and wait roughly 1 second each time for the scanning frame to reopen on mobile web. It's not just about wasting time;Non-depreciating fixed asset
Hi! There are non-depreciable fixed assets (e.g. land). It would be very useful to be able to create a new type of fixed asset (within the fixed assets module) with a ‘No depreciation’ depreciation method. There is always the option of recording landManaging Rental Sales in Zoho Inventory
I am aware that Zoho Inventory is not yet set up to handle rental sales and invoicing. Is anyone using it for rentals anyway? I'd like to hear about how others have found work arounds to manage inventory of rental equipment, rental payments, etc. ThMegamenu
Finally! Megamenu's are now available in Zoho-Sites, after waiting for it and requesting it for years! BUT ... why am I asked to upgrade in order to use a megamenu? First: Zoho promised to always provide premium versions and options for all included Zoho-applicationsCannot access KB within Help Center
Im working with my boss to customize our knowledge base, but for some reason I can see the KB tab, and see the KB categories, but I cannot access the articles within the KB. We have been troubleshooting for weeks, and we have all permissions set up, customersZoho Flow to Creator 3001 Respoonse
I have updated my Flows with the new V2 connection to Zoho Creator, but now some Flows do not work. They take in data from a Webhook and are supposed to create a record in Creator, however creator returns a 3001 message along with a failure, but I cannotFile Upload to Work Drive While Adding Records in Zoho Creator Application
Hi I am trying to set a file attachment field in zoho creator form, to enable the user to upload a scanned document from their local pc. The file should be uploaded to zoho workdrive and not to the default zoho creator storage. The file link should beWhy not possible to generate?
Using this https://desk.zoho.com/DeskAPIDocument#TicketCount#TicketCount_Getticketcountbyfield on my ZML script url :"https://desk.zoho.com/api/v1/ticketsCountByFieldValues?departmentId=XXXXXXXXXXX&accountId!=XXXXXXXXX&customField1=cf_country_1:XXXXXX&field=overDue"email
Hi My crm email is not working, can you check, I have zoho one account.Need option to see Mass Emails & Cadences in Gmail Outbox OR a dedicated Zoho Outbox
Hi everyone, Right now, when we send 1:1 emails from gmail (with gmail API connected to Zoho CRM), those emails appear both in gmail's sent folder and in Zoho CRM. That works well. But when we send Mass Emails or Cadence emails form Zoho CRM, they areI can't found API for Sales Receipts
Hello May you please help me to find an API document for Sales Receipts to get data and retrive a custom fields like Invoice and credit notes RegardsKaizen #205 - Answering Your Questions | Managing Picklists and Enabling History Tracking via Zoho CRM APIs
Hello everyone! Welcome back to another post in our Kaizen series. In this post, we will look at how you can manage picklist fields in Zoho CRM using APIs. This topic was raised as feedback to Kaizen #200, so we are taking it up here with more details.Multiple Vendor SKUs
One of the big concerns we have with ZOHO Inventory is lack of Vendor Skus like many other inventory software packages offer. Being able to have multiple vendor skus for the same product would be HUGE! It would populate the appropriate vendor Sku forInternally created tickets
Hi there When tickets are created internally on-behalf of customers - there is nothing to show that the ticket was created by an internal agent. This means, that it's easy for our agents to confuse tickets which were created by internal team members andAutomatically change website passwords
Hi everyone, We just switched to a Professional package to also use the "Automatically change website passwords" function. But I cannot find anything about it, how to use it, anywhere. Does anyone know how I can use this function? Best, CasparChange Invoice Prices for an Effective Date
Hi, It would be a really good feature to be able to change the prices on invoices/recurring invoices from an effective date in the event of price increases. For instance, I am in the process of increasing prices that will be effective from a specific"Other Current Asset" accounts as "Paid Through" accounts in Expense
It would be incredibly useful to be able to assign accounts of type Other Current Asset as Paid Through accounts in Expense. Currently, Other Current Liability are permitted as Paid Through Accounts. This makes sense, as Credit Cards are current liabilities.Multi column open text questions that allows respondents to add rows for additional information
I need to create a question that has 2 columns with open text, but I also need to allow respondents to click a "+" button, or something similar, so that they can add additional information if they choose to. I've tried using the Multiple Textboxes typeBot Filtering & Apple Mail Privacy Protection Compliance in Zoho Campaigns
Dear Campaigns Users, The wait is over! We’re excited to announce that the enhanced bot filtering feature is now live in Zoho Campaigns. This update brings greater accuracy to your email campaign reports by distinguishing real user engagement from automatedDécouvrons les détails qui simplifient vos journées de travail avec Trident
Nous nous installons dans des routines efficaces et rodées avec le temps. Chaque matin, nous ouvrons nos e-mails, passons aux messages, consultons notre agenda, puis attaquons nos tâches. Ce processus nous semble maîtrisé, mais est-il réellement optimiséIssue with Purchase Rate Showing as “0” After Importing Items List
Dear Zoho Books Support Team, Good day. I’m reaching out regarding an issue I’m facing while importing my items list into Zoho Books. Despite mapping all fields correctly and including the purchase price for each product in my Excel file, the PurchaseAPI for Task Entity in Zoho Books
I’m working on automating task creation in Zoho Books via a custom button in the Bills Module. The goal is to create a task in the Tasks Module and assign it to the Finance Team, so they can track progress efficiently. While reviewing Zoho Books documentation,create invoice in zoho books from the zoho forms
Is there a native way to have create invoice in zoho books, when zoho form is completed?Email undelivered
GOod Day I am always receiving an uncategorized-bounce to my email. I am not sure why this is happening.Add inventory_valuation_method to items endpooints
To ensure consistent item creation it would be helpful to have the inventory_valuation_method (FIFO vs WAC) be able to be set at item creation or as an update (consistent with current behavior where it is not allowed for items with existing transactions)Use Zoho to send sales receipts for Gocardless transactions
I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set upZoho - Gocardless sales receipts
I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set upIntroducing Rollup summary in Zoho CRM
------------------------------------------Moderated on 5th July'23---------------------------------------------- Rollup summary is now available for all organizations in all the DCs. Hello All, We hope you're well! We're here with an exciting update thatIntroducing Connected Workflows in Zoho CRM for Everyone : Free Your Teams to Focus on What Matters
Hello Everyone, We’re thrilled to introduce the next big evolution in Zoho CRM for Everyone -- Connected Workflows. This new feature builds on our commitment to deliver a CRM that’s truly inclusive, adaptable, and designed for consistent collaborationIntroducing Connected Records to bring business context to every aspect of your work in Zoho CRM for Everyone
Hello Everyone, We are excited to unveil phase one of a powerful enhancement to CRM for Everyone - Connected Records, available only in CRM's Nextgen UI. With CRM for Everyone, businesses can onboard all customer-facing teams onto the CRM platform toCooling-off Period Just Got Better: More Coverage, More Control
We’ve enhanced the Cooling-off Period feature in Zoho Recruit to give you more control over repeat applications and referrals. This helps you maintain a cleaner, more efficient recruitment pipeline. With this enhancement, you can: Prevent duplicate candidateRevenue Management: #7 Revenue Recongition in Construction & Real Estate Industry
If you are in the construction or real estate business, you are used to long project timelines and progressive invoicing to keep up with your billing. But when does revenue get recognized? Will it happen when the contract gets signed? At different milestonesTikTok (and other social platform) Messages and comments of the past
When I link a social channel, Zoho will show in "Inbox", "Messages" and "Contact" sections the interaction done in the past? (comment, messages...)Email Integration - Zoho CRM - OAuth and IMAP
Hello, We are attempting to integrate our Microsoft 365 email with Zoho CRM. We are using the documentation at Email Configuration for IMAP and POP3 (zoho.com) We use Microsoft 365 and per their recommendations (and requirements) for secure email we haveHow do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.
How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.Restrict Employee mail deletion
Dear Zoho, Is there a way where i can restrict my employees to delete any mails from their account554 5.1.8 Email Outgoing Blocked.
Hi guys, I just singed up for mateusz.nowicki@zoho.com mail and I can't send any mails.. Why? Everytime I try to send something I got error like the one in the screenshot. Please, help me.Zoho IP blocked by SpamHaus
ERROR CODE :550 - 5.7.0 Your server IP address is in the SpamHaus SBL-XBL database, byeFile Upload in Creator's Subfrom
Hello Sir/Madam, Here is a Problem......... Scenario: In CRM One Custom Module (Payments) have one File Upload Field now we have to Upload that File into Creator's Custom Form (Documents) have one Subform (Documents) in Document Upload Field using DelugeNext Page