downloadFile Method

Table of Contentsup

 Purpose

You can use this method to download files from CRM to your system.

 Request URL

XML Format:
https://<APPDOMAIN>/crm/private/xml/Leads/downloadFile?id=Attachment Id

JSON Format:
https://<APPDOMAIN>/crm/private/json/Leads/downloadFile?id=Attachment Id

 Auth Token

Auth Token is an encrypted alphanumeric string that is required to authenticate your CRM account credentials. A valid user's Authentication Token is necessary to access the API. When making an API request, send the authentication token in the Authorization header as shown below:

https://<APPDOMAIN>/crm/private/xml/Leads/downloadFile?id=Attachment Id

Header:

Authorization=1000XXXX65.1000XXXX44.caXXXXXXXXXXXX

(See Using Authentication Token )

 Request Parameters

ParameterData TypeDescription
id*StringSpecify unique ID of the attachment

* - Mandatory parameter

Important Note:

  • Your program can request only 15 downloadFile calls per 5 min. If API User requests more than 15 calls, system will block the API access for 15 min. 
  • You can download files only from Attachments section in the Record Details Page.