Delete an Attachment

Purpose

To delete an attachment added to a record in Zoho CRM.

Endpoints

  • DELETE /{module_api_name}/{record_ID}/Attachments/{attachment_ID}

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, Appointments, Services and Notes

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.{operation_type}
(and)
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, appointments, services and notes

Possible operation types

ALL - Full access to attachments
DELETE - Delete attachment data

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/2883756000000261075/Attachments/2883756000000261017"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

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 may have been removed from the list of available modules. Specify a valid module API name.
    • The given module is not supported in API
      Resolution: Specify a supported module name. Refer to the list of supported modules at the beginning of this page for more details.
  • INVALID_REQUEST_METHODHTTP 400

    The request method is incorrect.
    Resolution: Use the HTTP PUT method to make this API call. Any other request method will result in this error.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to delete attachments
    Resolution: Contact your system administrator.

  • INVALID_DATAHTTP 400

    The related id given seems to be invalid
    Resolution: The attachment ID specified in the URL is invalid. Refer to Get Related Records API to get valid related record IDs.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.modules.attachments.DELETE scope. Create a new access token with valid scope. Refer to scope section at the beginning of this page.

  • NO_PERMISSIONHTTP 403

    Permission denied to delete attachment
    Resolution: The user does not have permission to delete attachments. Contact your system administrator.

  • INVALID_URL_PATTERNHTTP 404

    The request URL is incorrect.
    Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details.

  • INTERNAL_ERRORHTTP 500

    Unexpected and unhandled exception in the server. 
    Resolution: Contact the support team at support@zohocrm.com.

Sample Response

Copied{
    "data": [
       {
            "code": "SUCCESS",
            "details": {
                "id": "2883756000000261017"
            },
            "message": "record deleted",
            "status": "success"
        }
    ]
}