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

Zoho Desk Resources

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

Sticky Posts
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
Extension pointers: Handle cases with personalized solutions using custom actions
In our last post, we detailed the steps involved in creating a custom action and the workflow from the developer and end user's side. Now let's look at a working example of how we can create a custom action and implement it in a Zoho CRM account to make
Extension pointers - Simple yet significant pointers #13: On change of field value for CRM variables
CRM variables provide global access to a variable across an entire extension. They also help in the storage of user-specific data provided by the user at the time of installation, which can later be fetched to perform data functionalities. Additionally,
Extension pointers: Extend end-user benefits and allow personalization by implementing extensions with custom actions
From our earlier post on custom actions, we know that we can create templated actions, share them with end users, and allow them to reuse those actions to achieve personalized outcomes. In this post, we'll look at how custom actions make it easy for users
Extension pointers - Simple yet significant pointers #12: Functions for Zoho CRM extensions
Functions are essential in achieving logical functionality for an extension. You can easily code your functions in Deluge using drag-and-drop tools to meet your requirements. How to create functions for Zoho CRM extensions in Sigma Go to Sigma and select