Upload an Attachment
Purpose
To attach a file to a record. You must include the attachment in the request with content type as multipart/form data.
Request Details
Request URL
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Attachments
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, and Notes
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(and)
scope=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, notes
Possible operation types
ALL - Full access to attachments
WRITE - Edit attachment data
CREATE - Create attachment data
Input form-data
- filefile, mandatory
Choose the attachment you want to upload.
Parameters
- titlestring, optional
The title of the attachment link.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2.1/Leads/1000000231009/Attachments"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-F "file=@attachment1.txt" (to upload file)
(or)
-F "attachmentUrl=https://www.zohocorp.com" (to upload link)
CopiedString moduleAPIName = "Leads";
Long recordId = 3477061000005177002L;
String absoluteFilePath = "/Users/use_name/Desktop/image.png";
//Get instance of AttachmentsOperations Class that takes moduleAPIName and recordId as parameter
AttachmentsOperations attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Get instance of FileBodyWrapper class that will contain the request file
com.zoho.crm.api.attachments.FileBodyWrapper fileBodyWrapper = new com.zoho.crm.api.attachments.FileBodyWrapper();
//Get instance of StreamWrapper class that takes absolute path of the file to be attached as parameter
StreamWrapper streamWrapper = new StreamWrapper(absoluteFilePath);
//Set file to the FileBodyWrapper instance
fileBodyWrapper.setFile(streamWrapper);
//Call uploadAttachment method that takes FileBodyWrapper instance as parameter
APIResponse < ActionHandler > response = attachmentsOperations.uploadAttachment(fileBodyWrapper);
Copiedpackage com.zoho.crm.api.sample.restapi.filesandattachments;
import java.io.ByteArrayOutputStream;
import java.io.FileInputStream;
import java.io.InputStream;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.ByteArrayBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class UploadanAttachment
{
public static void main(String[] args)
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/Leads/34770617711001/Attachments");
HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
MultipartEntityBuilder multipartEntity = MultipartEntityBuilder.create();
java.io.File file = new java.io.File("/Users/username/Desktop/zoho.jpeg");
@SuppressWarnings("resource")
InputStream stream = new FileInputStream(file);
byte[] buffer = new byte[8192];
ByteArrayOutputStream output = new ByteArrayOutputStream();
int bytesRead;
while ((bytesRead = stream.read(buffer)) != -1)
{
output.write(buffer, 0, bytesRead);
}
multipartEntity.addPart("file", new ByteArrayBody(output.toByteArray(), file.getName()));
requestBase.setEntity(multipartEntity.build());
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}
Copied//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
$attachmentOperations = new AttachmentsOperations($moduleAPIName, $recordId);
//Get instance of FileBodyWrapper class that will contain the request file
$fileBodyWrapper = new FileBodyWrapper();
//Get instance of StreamWrapper class that takes absolute path of the file to be attached as parameter
$streamWrapper = new StreamWrapper(null, null, $absoluteFilePath);
//Set file to the FileBodyWrapper instance
$fileBodyWrapper->setFile($streamWrapper);
//Call uploadAttachment method that takes FileBodyWrapper instance as parameter
$response = $attachmentOperations->uploadAttachment($fileBodyWrapper);
Copied<?php
class UploadAttachment
{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$curl_options[CURLOPT_URL] = "https://www.zohoapis.com/crm/v2.1/Leads/3524033000005495065/Attachments";
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "POST";
$fileName = "response.json";
$filePath = "/Users/test/PHP/PHPNativeSampleCode/response.json";
$file = fopen($filePath, "rb");
$fileData = fread($file, filesize($filePath));
$date = new \DateTime();
$current_time_long= $date->getTimestamp();
$lineEnd = "\r\n";
$hypen = "--";
$contentDisp = "Content-Disposition: form-data; name=\""."file"."\";filename=\"".$fileName."\"".$lineEnd.$lineEnd;
$data = utf8_encode($lineEnd);
$boundaryStart = utf8_encode($hypen.(string)$current_time_long.$lineEnd) ;
$data = $data.$boundaryStart;
$data = $data.utf8_encode($contentDisp);
$data = $data.$fileData.utf8_encode($lineEnd);
$boundaryend = $hypen.(string)$current_time_long.$hypen.$lineEnd.$lineEnd;
$data = $data.utf8_encode($boundaryend);
$curl_options[CURLOPT_POSTFIELDS]= $data;
$headersArray = array();
$headersArray = ['ENCTYPE: multipart/form-data','Content-Type:multipart/form-data;boundary='.(string)$current_time_long];
$headersArray[] = "content-type".":"."multipart/form-data";
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$jsonResponse = json_decode($content, true);
if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$jsonResponse = json_decode($content, true);
}
var_dump($headerMap);
var_dump($jsonResponse);
var_dump($responseInfo['http_code']);
}
}
(new UploadAttachment())->execute();
Copied//Get instance of AttachmentsOperations Class that takes moduleAPIName and recordId as parameter
AttachmentsOperations attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Get instance of FileBodyWrapper class that will contain the request file
API.Attachments.FileBodyWrapper fileBodyWrapper = new API.Attachments.FileBodyWrapper();
//Get instance of StreamWrapper class that takes absolute path of the file to be attached as parameter
StreamWrapper streamWrapper = new StreamWrapper (absoluteFilePath);
//Set file to the FileBodyWrapper instance
fileBodyWrapper.File = streamWrapper;
//Call UploadAttachment method that takes FileBodyWrapper instance as parameter
APIResponse<API.Attachments.ActionHandler> response = attachmentsOperations.UploadAttachment(fileBodyWrapper);
Copiedusing System;
using System.IO;
using System.Net;
using System.Text;
namespace Com.Zoho.Crm.API.Sample.RestAPI.FilesandAttachments
{
public class UploadanAttachment
{
public static void UploadAttachment()
{
string boundary = "----FILEBOUNDARY----";
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Leads/347706107711001/Attachments");
request.ContentType = "multipart/form-data; boundary=" + boundary;
request.Method = "POST";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
request.KeepAlive = true;
FileInfo fileInfo = new FileInfo("/Users/abc-123/Desktop/zoho.jpeg");
string name = fileInfo.Name;
Stream stream = fileInfo.OpenRead();
Stream fileDataStream = new MemoryStream();
var boundarybytes = Encoding.UTF8.GetBytes("\r\n--" + boundary + "\r\n");
var endBoundaryBytes = Encoding.UTF8.GetBytes("\r\n--" + boundary + "--");
string headerTemplate = "Content-Disposition: form-data; name=\"{0}\"; filename=\"{1}\"\r\n" + "Content-Type: application/octet-stream\r\n\r\n";
fileDataStream.Write(boundarybytes, 0, boundarybytes.Length);
var header = string.Format(headerTemplate, "file", name);
var headerbytes = System.Text.Encoding.UTF8.GetBytes(header);
fileDataStream.Write(headerbytes, 0, headerbytes.Length);
var buffer = new byte[1024];
var bytesRead = 0;
while ((bytesRead = stream.Read(buffer, 0, buffer.Length)) != 0)
{
fileDataStream.Write(buffer, 0, bytesRead);
}
fileDataStream.Write(endBoundaryBytes, 0, endBoundaryBytes.Length);
request.ContentLength = fileDataStream.Length;
using (Stream requestStream = request.GetRequestStream())
{
fileDataStream.Position = 0;
byte[] tempBuffer = new byte[fileDataStream.Length];
fileDataStream.Read(tempBuffer, 0, tempBuffer.Length);
fileDataStream.Close();
requestStream.Write(tempBuffer, 0, tempBuffer.Length);
}
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
}
}
Copied# Get instance of AttachmentsOperations Class that takes module_api_name and record_id as parameters
attachments_operations = AttachmentsOperations(module_api_name, record_id)
# Get instance of FileBodyWrapper class that will contain the request file
file_body_wrapper = FileBodyWrapper()
"""
StreamWrapper can be initialized in any of the following ways
* param 1 -> fileName
* param 2 -> Read Stream.
"""
# stream_wrapper = StreamWrapper(stream=open(absolute_file_path, 'rb'))
"""
* param 1 -> fileName
* param 2 -> Read Stream
* param 3 -> Absolute File Path of the file to be attached
"""
stream_wrapper = StreamWrapper(file_path=absolute_file_path)
# Set file to the FileBodyWrapper instance
file_body_wrapper.set_file(stream_wrapper)
# Call upload_attachment method that takes FileBodyWrapper instance as parameter
response = attachments_operations.upload_attachment(file_body_wrapper)
Copieddef upload_an_attachment():
import requests
url = 'https://www.zohoapis.com/crm/v2.1/Leads/3409643000003088001/Attachments'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268'
}
request_body = {
'file': open(
'/Users/aswin-7455/Documents/SDK-workspace/latest-git-csez/python/latest/zohocrm-python-sdk/img_2.png',
'rb')
}
response = requests.post(url=url, files=request_body, headers=headers)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
upload_an_attachment()
Copied//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Get instance of FileBodyWrapper class that will contain the request file
let fileBodyWrapper = new FileBodyWrapper();
/** StreamWrapper can be initialized in any of the following ways */
/**
* param 1 -> fileName
* param 2 -> Read Stream.
*/
let streamWrapper = new StreamWrapper(null, fs.createReadStream(absoluteFilePath));
/**
* param 1 -> fileName
* param 2 -> Read Stream
* param 3 -> Absolute File Path of the file to be attached
*/
// let streamWrapper = new StreamWrapper(null, null, absoluteFilePath);
//Set file to the FileBodyWrapper instance
fileBodyWrapper.setFile(streamWrapper);
//Call uploadAttachment method that takes FileBodyWrapper instance as parameter
let response = await attachmentsOperations.uploadAttachment(fileBodyWrapper);
Copiedasync function uploadAnAttachment() {
const got = require("got");
const FormData = require("form-data");
const fs = require("fs");
let url = 'https://www.zohoapis.com/crm/v2.1/Leads/3409643000003088001/Attachments'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let requestBody = new FormData()
requestBody.append('file', fs.createReadStream('/Users/abc-123/Desktop/img.png'))
let requestDetails = {
method : "POST",
headers : headers,
body : requestBody,
encoding: "utf8",
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
uploadAnAttachment()
Copied# Get instance of AttachmentsOperations Class that takes record_id and module_api_name as parameters
ao = Attachments::AttachmentsOperations.new(module_api_name,record_id)
# Get instance of FileBodyWrapper class that will contain the request file
fbw = Attachments::FileBodyWrapper.new
# """
# StreamWrapper can be initialized in any of the following ways
# * param 1 -> fileName
# * param 2 -> Read Stream.
# * param 3 -> Absolute File Path of the file to be attached
# """
# stream_wrapper = StreamWrapper.new(name,stream,absolutefilepath)
sw = Util::StreamWrapper.new(nil, nil, absolute_file_path)
# Set file to the FileBodyWrapper instance
fbw.file = sw
# Call upload_attachment method that takes FileBodyWrapper instance as parameter
response = ao.upload_attachment(fbw)
Copiedrequire 'net/http'
require 'json'
class UploadAttachment
def execute
url = "https://www.zohoapis.com/crm/v2.1/Leads/3524033000005495065/Attachments"
url = URI(url)
req = Net::HTTP::Post.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
headers={}
headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
headers&.each { |key, value| req.add_field(key, value) }
file_path = "/Users/test/Desktop/pic.png"
file = File.open(file_path)
data=[["file",file.read, { filename: "pic.png" }]]
req.set_form(data,'multipart/form-data')
response=http.request(req)
status_code = response.code.to_i
headers = response.each_header.to_h
print status_code
print headers
unless response.body.nil?
print response.body
end
end
end
UploadAttachment.new.execute
Copiedphoto = invokeUrl
[
url: "https://pbs.twimg.com/text.txt"
type: GET
];
photo.setParamName("file");
response = invokeurl
[
url: "https://www.zohoapis.com/crm/v2.1/Leads/1000000231009/Attachments"
type: POST
files: photo
connection:"crm_oauth_connection"
];
Possible Errors
- 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 could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.attachments.CREATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to upload attachment
Resolution: The user does not have permission to upload attachments. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to upload attachments
Resolution: The user does not have the permission to upload attachments. Contact your system administrator. - INVALID_DATAHTTP 400
the related id given seems to be invalid
Resolution: The related record ID specified in the URL is invalid. Refer to Get Related Records API to get valid related record IDs.
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2021-05-03T18:03:00+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"Created_Time": "2021-05-03T18:03:00+05:30",
"id": "4150868000005277036",
"Created_By": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
}
},
"message": "attachment uploaded successfully",
"status": "success"
}
]
}