Download Field Attachments

Purpose

To retrieve attachments from file upload and image upload fields in Zoho CRM modules

Endpoints

GET /{module_API_name}/{record_ID}/actions/download_fields_attachment?fields_attachment_id={attachment_id}

Request Details

Request URL

{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/download_fields_attachment

Supported modules

Leads, Accounts, Contacts, Deals, Tasks, Meetings, Calls, Products, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Campaigns, Vendors, Cases, Solutions, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.modules.{module_name}.READ

Parameters

fields_attachment_idstring, mandatory
The unique ID of the attachment of either the file upload field or the image upload field in the module. You can obtain this ID using the Get Records API for that specific record.

Possible Errors

INVALID_DATAHTTP 400
The ID of the record is invalid.
Resolution: Specify the correct record ID.
REQUIRED_PARAM_MISSINGHTTP 400
You have not specified the fields_attachment_id parameter.
Resolution: Specify a valid value for the fields_attachment_id parameter. Refer to the Parameters section for more details.
NO_PERMISSIONHTTP 403
You do not have permission to download the attachments of the record in this module.
Resolution: Contact your administrator.
INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details.
INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in the server.
Resolution: Contact the support team at support@zohocrm.com.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/554023000001054001/actions/download_fields_attachment?fields_attachment_id=554023000001736007"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"