Tools and News for Developers using the AllClients Platform

GetAttachmentDownloadURL

Overview

Get a download URL for a specified contact attachment via an http form post.

To get a list of a contact’s attachments, use GetContactAttachments first, then use this function GetAttachmentDownloadURL to get a temporary download link.  (The link expires in 5 minutes)

Post Url

https://www.allclients.com/api/2/GetAttachmentDownloadURL.aspx
  • SSL is requred
  • White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.

Form Fields

Field Max Length* Required Notes
response_type   No Default results will be returned in XML.Set this field value to json to return results in JSON format
accountid   Yes Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
apikey   Yes API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
contactid   Yes  
filename 75 Yes  

* An error will not result if Max Length is exceeded. Data will be trimmed to this length. 

Sample Results

Success Message

<?xml version="1.0"?>
<results>
<downloadurl>
[temporary url]
</downloadurl>
<url_expires_in>5 minutes</url_expires_in>
</results>