Download an Attachment

Purpose

To retrieve and download a file attached to a record in Zoho CRM.

 

Endpoints

  • GET /{module_api_name}/{record_ID}/Attachments/{attachment_ID}

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_ID}/Attachments/{attachment_ID}

Supported modules

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

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.{operation_type}
(and)
ZohoCRM.modules.attachments.{operation_type}

Possible module names

leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, appointments, services and notes

Possible operation types

ALL - Full access to attachments
READ - Get attachment data

Note

  • You can only download attachments of file type, and not link type.
  • To retrieve the Attachment IDs, use the Get Related Records API.

Possible Errors

  • DOWNLOAD_NOT_ALLOWEDHTTP 400

    You are trying to download a link attachment.
    Resolution: You can only download file type attachment with this API.

  • INVALID_REQUEST_METHODHTTP 400

    The request method is incorrect.
    Resolution: Use the HTTP GET method to make this API call. Any other request method will result in this error.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to download attachments.
    Resolution: Contact your system administrator.

  • INVALID_DATAHTTP 400

    You have specified an invalid record ID.
    Resolution: Specify a valid record ID.

  • INVALID_MODULEHTTP 400
    • The module name given seems to be invalid
      Resolution: You have specified an invalid module name or there is no tab permission, or the module may have been removed from the available modules. Specify a valid module API name.
    • The given module is not supported in API.
      Resolution: Specify a valid and supported module API name. Refer to the list of supported modules at the beginning of this page for more details.
  • OAUTH_SCOPE_MISMATCHHTTP 401

    The access token you have used to make this API call does not have the required scope.
    Resolution: Generate a new access token with the required scopes for this API. Refer to the Scope section at the beginning of this page for the list of required scopes.

  • NO_PERMISSIONHTTP 403

    Permission denied to download attachment.
    Resolution: Contact your system 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

CurlDeluge
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/100023009/Attachments/100013547"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/Leads/100023009/Attachments/100013547"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

The requested file will be downloaded.