Kaizen #46 - Handling Notes through Zoho CRM API (Part 1/2)

Kaizen #46 - Handling Notes through Zoho CRM API (Part 1/2)

Hello everyone!
Welcome back to another week of Kaizen!
This week, we will discuss Handling Notes through Zoho CRM API.

What will you learn from this post?
  1. Notes in Zoho CRM
  2. Working with Notes through Notes APIs
1. Notes in Zoho CRM

1a. Why add Notes to records?
Notes are a great way to summarize your observations on customer and prospect interactions and outcomes. By saving notes as CRM data, a sales rep will always be able to keep track of how a sale is progressing. To know more about notes in Zoho CRM, click here

1b. Associated Modules
You can attach notes to the records in the following modules:
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom.

2. Working with Notes through Notes APIs

Request URL to get all the notes from all the modules: {{api-domain}}/crm/v2/Notes
Request URL to get a specific note: {{api-domain}}/crm/v2/Notes/{note_id}
Request URL with pagination parameters: {{api-domain}}/crm/v2/Notes?page=2&per_page=200 //fetches note records from 201-400, based on their position in Zoho CRM

Request method: GET

Sample Response
{
    "data": [
        {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013",
                "email": "patricia.b@zohocorp.com"
            },
            "Modified_Time": "2020-07-28T11:58:59+05:30",
            "$attachments": null,
            "Created_Time": "2020-07-28T11:55:47+05:30",
            "Parent_Id": {
                "name": null,
                "id": "4150868000002567076"
            },
            "$editable": true,
            "$se_module": "Leads",
            "$is_shared_to_client": false,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013",
                "email": "patricia.b@zohocorp.com"
            },
            "$size": null,
            "$voice_note": false,
            "id": "4150868000002748029",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013",
                "email": "patricia.b@zohocorp.com"
            },
            "Note_Title": "Contacted",
            "Note_Content": null
        }
    ],
    "info": {
        "per_page": 1,
        "count": 1,
        "page": 1,
        "more_records": true
    }
}

Response JSON Keys
Key
Description
Owner
JSON Object
Represents the name, ID, and email ID of the owner of the note. This is a read-only field.
Modified_Time
Date and time in ISO 8601 format
Represents the date and time at which the note was last modified. This is a read-only field.
$attachments
JSON array
Represents the details of the attachments of the note. 
Created_Time
Date and time in ISO 8601 format
Represents the date and time at which the note was created. This is a read-only field.
Parent_Id
JSON object
Represents the name and unique ID of the parent record.
$editable
Boolean
Represents if the current user has the permission edit notes.
$se_module
String
Represents the API name of the parent module.
$is_shared_to_client
Boolean
Represents if the note is shared with a client portal user
Modified_By
JSON Object
Represents the name, ID, and email ID of the user who last modified the note.This is a read-only field.
$size
Integer
Represents the size of the voice note in bytes, if any. 
$voice_note
Boolean
Represents if the current note has a voice note attached. 
id
String
Represents the unique ID of the note.
Created_By
JSON object
Represents the name, ID, and email ID of the user who created the note. This is a read-only field.
Note_Title
String
Represents the title of the note.
Note_Content
String
Represents the content of the note.

Request URL: {{api-domain}}/crm/v2/Notes
Request Method: POST

Sample Input
{
    "data": [
        {
            "Note_Title": "Contacted",
            "Note_Content": "Need to do further tracking",
            "Parent_Id": "4150868000002748005",
            "se_module": "Leads"
        }
    ]
}

Input JSON Keys
Key
Description
Note_Title
String
The title of the note.
Note_Content
String
The note content.
Parent_Id
String
The unique ID of the parent record.
se_module
String
The API name of the parent module.

Things of note
  1. You cannot add values for the following read_only fields: Owner, Modified_Time, Created_Time, Modified_By, and Created_By.
  2. You can create a maximum of 100 notes per API call.
Sample Response


Request URL: {{api-domain}}/crm/v2/Notes
Request URL to update a specific note: {{api-domain}}/crm/v2/Notes/{note_id}

Request Method: PUT

Sample input to update a specific note:
{
    "data": [
        {
            "Note_Title": "Contacted",
            "Note_Content": "Junk Lead"
        }
    ]
}

Sample Response


Things of note
  1. When you update multiple notes, add "id" of the note in the request body. You can retrieve it using Get Notes API
  2. You can update only two fields of a note: Note_Title and Note_Content. You cannot update values for the following read_only fields: Owner, Modified_Time, Created_Time, Modified_By, and Created_By.
  3. You can update a maximum of 100 notes per API call.
Request URL: {{api-domain}}/crm/v2/Notes?ids={id1,id2,..}
Request URL to delete a specific note: {{api-domain}}/crm/v2/Notes/{note_id}

Request Method: DELETE

Sample Response


Things of note
  1. You can delete a maximum of 100 notes 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!






      Zoho Campaigns Resources


        • Desk Community Learning Series


        • Digest


        • Functions


        • Meetups


        • Kbase


        • Resources


        • Glossary


        • Desk Marketplace


        • MVP Corner


        • Word of the Day


        • Ask the Experts


          Zoho CRM Plus Resources

            Zoho Books Resources


              Zoho Subscriptions Resources

                Zoho Projects Resources


                  Zoho Sprints Resources


                    Zoho Orchestly Resources


                      Zoho Creator Resources


                        Zoho WorkDrive Resources



                          Zoho CRM Resources

                          • CRM Community Learning Series

                            CRM Community Learning Series


                          • Tips

                            Tips

                          • Functions

                            Functions

                          • Meetups

                            Meetups

                          • Kbase

                            Kbase

                          • Resources

                            Resources

                          • Digest

                            Digest

                          • CRM Marketplace

                            CRM Marketplace

                          • MVP Corner

                            MVP Corner




                            Zoho Writer Writer

                            Get Started. Write Away!

                            Writer is a powerful online word processor, designed for collaborative work.

                              Zoho CRM コンテンツ




                                ご検討中の方

                                  • Recent Topics

                                  • javax.mail.authenticationfailedexception 535 authentication failed

                                    Hi, I am facing 535 authentication failed error when trying to send email from zoho desktop as well as in webmail. Can you suggest to fix this issue,. Regards, Rekha
                                  • Zoho Sign: need to leave document pending for up to a year, or maybe there's a better way?

                                    I have zoho one, maybe there's a better way to do this with another service than sending a zoho sign template from zoho crm. At the end of the day this requirement is due to regulations, no matter how dumb it may seem. I'm just looking for a way of getting
                                  • Separate Items & Services

                                    Hi, please separate items and services into different categories. Thank you
                                  • Unable to edit or delete email address

                                    I signed up for free Zoho today. I usually am pretty good at understanding and configuring things like this, but your interface baffles me, and your online help is cryptic to say the least. I have spent hours just trying to set up a couple of email accounts in Zoho before pointing my domain MX records to Zoho. I solved some other issues on my own, but I can't figure out this latest problem: I have created two email addresses in Zoho. Let's call the first one myname@mydomain.com and the second one
                                  • Mastering Zia Match Scores | Let's Talk Recruit

                                    Feeling overwhelmed by hundreds of resumes for every job? You’re not alone! Welcome back to Let’s Talk Recruit, where we break down Zoho Recruit’s features and hiring best practices into simple, actionable insights for recruiters. Imagine having an assistant
                                  • We are unable to process your request now. Please try again after sometime or contact support@zohoaccounts.com

                                    I cannot sign up and return the error of we are unable to process your request now. Please try again after sometime or contact support@zohoaccounts.com
                                  • Multi-currency - What's cooking ?

                                    Hi,       We have been doing this feature for sometime and we would like to give you some glimpses of it.  Working with Multi Currency :        Multicurrency support gives you the ability to handle business transactions in multiple currencies. You can define a base currency for your organization and add more currencies with exchange rates based on the base currency.  Setup :        From the setup page, you can manage all the currencies supported by your organization.       Currencies page        
                                  • How to reduce programmatically the image uploaded by user?

                                    I need a function that will automatically reduce the pixel dimension to 800 x 600 pixels / 180 resolution or (approx. 1.37MB) of image uploaded by user from digital camera, for example, 2271 x 1704 pixels /180 resolution or approx. 11.1MB. After the user selected the image, the function will able to detect if pixels is above 800x600, process the photo (crop/ reduce) and resume upload. Need help...  
                                  • Dark mode for Zoho Creator / Zoho CRM Code editor

                                    Hi Team, Is there any plans for Dark mode in Zoho creator / Zoho Crm code editor and development pages in pipeline?
                                  • Is there a way to make a button scroll down?

                                    Looking to have a button on a landing page scroll down to another section on the page. Any recomendations outside of coding?
                                  • Collective-booking event not added to all staff calendars

                                    We assign two staff to certain events. When the client books this event, it adds it to one staff calendar (the 'organiser') but not the other. How can I ensure all staff assigned to a collective booking get the event in their calendar? (A side note: it
                                  • ZOHO Android Client

                                    Hi, I installed the Android app, but it had an issue, so I reinstalled it. I was able to add multiple accounts, but now when I add the next account, it just duplicates the one I already have and will not even allow me to enter the info for another account.
                                  • 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 align
                                  • Enhance 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;
                                  • Managing 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. Th
                                  • Zoho 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 cannot
                                  • File 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 be
                                  • Why 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 are
                                  • I 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 Regards
                                  • Kaizen #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 for
                                  • Internally 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 and
                                  • Automatically 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, Caspar
                                  • Change 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 type
                                  • Bot 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 automated
                                  • Dé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 Purchase
                                  • API 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 up
                                  • Zoho - 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 up
                                  • Introducing 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 that
                                  • Introducing 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 collaboration
                                  • Cooling-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 candidate
                                  • Next Page