downloadPhoto Method

Table of Contentsup

 Purpose

You can use this method to download the photos of Leads or Contacts.

 Request URL

XML Format:

For Leads:
https://<APPDOMAIN>/crm/private/xml/Leads/downloadPhoto?id=RecordID

For Contacts:
https://<APPDOMAIN>/crm/private/xml/Contacts/downloadPhoto?id=RecordID

JSON Format:

For Leads:
https://<APPDOMAIN>/crm/private/json/Leads/downloadPhoto?id=RecordID

For Contacts:
https://<APPDOMAIN>/crm/private/json/Contacts/downloadPhoto?id=RecordID

 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/downloadPhoto?id=RecordID

Header:

Authorization=1000XXXX65.1000XXXX44.caXXXXXXXXXXXX

(See Using Authentication Token )

 Request Parameters

ParameterData TypeDescription
id*StringSpecify unique ID of the record

* - Mandatory parameter

Note:

  • You will receive image file (PNG, JPG, GIF etc.,) as the response while executing this method. Programmatically download the image to your system and complete the other operations as per your API integration requirements.