Kaizen #47 Handling Notes through Zoho CRM API (Part 2/2)

Hello everyone!

Welcome back to yet another post in the Kaizen series!

In our last post, we started our discussion with Notes APIs in Zoho CRM.

This week, we will discuss the following:

Notes as related lists
Attaching files to notes via API

1. Notes as Related Lists

Notes API allows you to manipulate all the notes in all the modules, or specific notes based on their note IDs. Zoho CRM API also allows you to handle notes of a specific record using the related lists API.

The request URL will differ when you read/add/update/delete a note, as a related list. The structure of the URL would be:

To manipulate all the notes of a record: {{api-domain}}/crm/v2/{module_api_name}/{record_id}/Notes

(or)

To manipulate a specific note: {{api-domain}}/crm/v2/{module_api_name}/{record_id}/Notes/{note_id}

Sample Response to add note to a record:

Things of note:

It is mandatory to specify the note ID in the request body when you update the notes of a specific record.
It is mandatory to specify the note ID in the request URL or ids parameter when you delete the notes of a specific record.
All the above mentioned operations can also be achieved using the Notes APIs.

2. Attaching files to notes

You can attach files (images, audio, video, and so on) to notes via API. To attach files, you must first upload them to ZFS, and use the ID received to attach them to notes.

To get and update the attachment details of notes, you can use the Get Notes and Update Notes API respectively. You will get the details in the "$attachments" JSON array where each object in the array represents the unique ID of the attachment.

2a. Attaching files to notes while note creation

Specify the ZFS file ID in the "id" key in the "$attachments" JSON array.

"$attachments": [

{

"id": "9943645bd4411e51145e0515bd77e380385aef2ab242da01182fae5958fc3018"

}

]

2b. To add an attachment to an existing note

Request URL: {{api-domain}}/crm/v2/Notes/{note_id}/Attachments

Request Method: POST

Add the attachment file in the request body as form-data.

Note:

You can attach more than one attachment to a note.
Ensure that size of each attachment file does not exceed 20 MB.

2c. To delete attachments from notes

Request URL: {{api-domain}}/crm/v2/Notes/{note_id}/Attachments/{attachment_id}

Request Method: DELETE

Sample Response

Note:

You can delete only one attachment 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!

Previous 'Kaizen' - Handling Notes through Zoho CRM API (Part 1/2)

Next 'Kaizen' - Related Lists and Related Records #API

Access your files securely from anywhere

Zoho Developer Community

New to Zoho LandingPage?

Access Zoho LandingPage

Zoho LandingPage Resources

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Tout forum

France ZUGs

Zoho SalesIQ Resources

Sticky Posts
Kaizen#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 provide
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
Extension 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 API
Kaizen #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
Extension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes