Kaizen #58 - Attachments and Photo #API
Hello everyone!
Welcome back to another post in the Kaizen series.
This week, we will discuss how you can upload, delete, and fetch the attachments of a record in a module.
We will also discuss how you can upload, download, and delete the photo of a record in a module.
What is an attachment?
An attachment could be a file (image, text file, video etc) or a link that you want to upload to a record. Attachments add more information to a record that can otherwise not be displayed.
1. Upload an attachment to a record
Request URL: {api-domain}/crm/v2/{module_api_name}/{record_id}/Attachments
Request method: POST
Scope: ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.{operation_type}
(and)
ZohoCRM.modules.attachments.ALL/CREATE/WRITE
You must upload the attachment as form-data.
Here is a screenshot to upload a file as an attachment to a contact.
Here is a screenshot to upload a link as an attachment to a contact.
Sample Response
Note
- You cannot upload the organization's photo through this API. Use the Upload Org photo API, instead.
- You can also use this API to upload an attachment to a note. The request URL would be {api-domain}/crm/v2/Notes/{note_id}/Attachments.
- When you exceed the storage limit for the attachments for your edition, you can purchase additional storage. Click here to know more.
Possible Errors
Error Code | Reason | Handling |
INVALID_DATA | You are trying to add the existing URL as an attachment. | All the attachment URLs must be unique. |
INVALID_DATA | You are trying to attach a file and a URL in the same request. | You can attach either a file or a URL at a time. |
2. Get the list of attachments
Request URL: {api-domain}/crm/v2/{module_api_name}/{record_id}/Attachments
Request method: GET
Scope: ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.{operation_type}
(and)
ZohoCRM.modules.attachments.ALL/READ
Sample Response
3. Download an attachment
Request URL: {api-domain}/crm/v2/{module_api_name}/{record_id}/Attachments/{attachment_id}
Request method: GET
Scope: ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.{operation_type}
(and)
ZohoCRM.modules.attachments.ALL/READ
Note
You cannot download links but only files like image, PDF, text etc using this API.
Sample Response
4. Upload a photo to a record
A photo refers to the display picture of a record. Using this API, you can upload, download, and delete the display picture of the records in a module.
Leads, Contacts, Accounts, Products, Vendors, and custom modules are supported in this API.
Request URL: {api-domain}/crm/v2/{module_api_name}/{record_id}/photo
Request method: POST
Scope: ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.ALL/CREATE/WRITE
You must send the image as form-data.
Note
The photo you want to upload must not exceed the allowed size(10 MB) or the allowed resolution(10 MP).
Here is an example.
5. Download the photo of a record
Request URL: {api-domain}/crm/v2/{module_api_name}/{record_id}/photo
Request method: GET
Scope: ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.ALL/READ
Here is an example.
6. Delete the photo of a record
Request URL: {api-domain}/crm/v2/{module_api_name}/{record_id}/photo
Request method: DELETE
Scope: scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.ALL/DELETE
Here is an example.
We hope you found this post useful. We will meet next week with another one.
Let us know your questions in the comments section, or write to us at support@zohocrm.com.
Cheers!
Access your files securely from anywhere
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
Shylaja S
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 provideClient 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! CommandsExtension 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 APIKaizen #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 achievedExtension 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
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns 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セミナー