Delete an Attachment
Purpose
To delete a file attached to a record.
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, 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
DELETE - Delete attachment data
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2.1/Leads/2883756000000261075/Attachments/2883756000000261017"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedString moduleAPIName = "Leads";
Long recordId = 3477061000005177002L;
Long attachmentId = 3477061000005177002L;
//Get instance of AttachmentsOperations Class that takes moduleAPIName and recordId as parameter
AttachmentsOperations attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Call getAttachments method that takes recordId as parameter
APIResponse < ActionHandler > response = attachmentsOperations.deleteAttachment(attachmentId);
Copiedpackage com.zoho.crm.api.sample.restapi.filesandattachments;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpDelete;
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.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class DeleteanAttachment
{
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/34770617783004");
HttpUriRequest requestObj = new HttpDelete(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}
Copied//Get instance of RecordOperations Class that takes recordId and moduleAPIName as parameter
$attachmentOperations = new AttachmentsOperations($moduleAPIName, $recordId);
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
foreach($attachmentIds as $attachmentId)
{
$paramInstance->add(DeleteAttachmentsParam::ids(), $attachmentId);
}
//Call deleteAttachments method that takes paramInstance as parameter
$response = $attachmentOperations->deleteAttachments($paramInstance);
Copied<?php
class DeleteAttachment
{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2.1/Leads/3524033000005495065/Attachments/3524033000006023001";
$curl_options[CURLOPT_URL] = $url;
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "DELETE";
$headersArray = array();
$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 DeleteAttachment())->execute();
Copied//Get instance of AttachmentsOperations Class that takes moduleAPIName and recordId as parameter
AttachmentsOperations attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
foreach (long attachmentId in attachmentIds)
{
paramInstance.Add(DeleteAttachmentsParam.IDS, attachmentId);
}
//Call DeleteAttachments method that takes paramInstance as parameter
APIResponse<API.Attachments.ActionHandler> response = attachmentsOperations.DeleteAttachments(paramInstance);
Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.FilesandAttachments
{
public class DeleteanAttachment
{
public static void DeleteAttachment()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Leads/34770617711001/Attachments/34770617763001");
request.Method = "DELETE";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
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)
# Call delete_attachment method that takes attachment_id as parameter
response = attachments_operations.delete_attachment(attachment_id)
Copieddef delete_an_attachment():
import requests
url = 'https://www.zohoapis.com/crm/v2.1/Leads/3409643000002267003/Attachments/3409643000002847003'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268'
}
response = requests.delete(url=url, headers=headers)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
delete_an_attachment()
Copied//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Call deleteAttachment method that takes attachmentId as parameter
let response = await attachmentsOperations.deleteAttachment(attachmentId);
Copiedasync function deleteAnAttachment() {
const got = require("got")
let url = 'https://www.zohoapis.com/crm/v2.1/Leads/3409643000002267003/Attachments/3409643000002847003'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let requestDetails = {
method : "DELETE",
headers : headers,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
deleteAnAttachment()
Copied# Get instance of ParameterMap Class
pm = ParameterMap.new
# Add the ids to parameter map instance
attachment_ids.each do |attachment_id|
pm.add(Attachments::AttachmentsOperations::DeleteAttachmentsParam.ids, attachment_id)
end
# Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
ao = Attachments::AttachmentsOperations.new(module_api_name,record_id)
# Call delete_attachments method that takes pm as parameter
response = ao.delete_attachments(pm)
Copiedrequire 'net/http'
require 'json'
class DeleteAttachment
def execute
url = "https://www.zohoapis.com/crm/v2.1/Leads/3524033000005495065/Attachments/3524033000006019011"
url = URI(url)
req = Net::HTTP::Delete.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) }
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
DeleteAttachment.new.execute
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2.1/Leads/2883756000000261075/Attachments/2883756000000261017"
type: DELETE
connection:"crm_oauth_connection"
];
info response;
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.DELETE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to delete attachment
Resolution: The user does not have permission to delete 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 delete attachments
Resolution: The user does not have the permission to delete 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": {
"id": "2883756000000261017"
},
"message": "record deleted",
"status": "success"
}
]
}