Delete a Photo

Purpose

To delete a photo from a record in a module.

Endpoints

DELETE /{module_api_name}/{record_id}/photo

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_id}/photo

Supported modules

Leads, Contacts, Accounts, Products, Vendors, and custom modules

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, contacts, accounts, products, vendors and custom modules

Possible operation types

ALL - Full access to images
DELETE - Delete photo

Sample Request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/crm/v5/Leads/3000000038009/photo"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v5/Leads/3000000038009/photo"
	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. Specify a valid module API name. Refer to the possible module names section above.
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. Refer to the possible module names section above.
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.{module_name}.DELETE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to delete images
Resolution: The user does not have permission to delete images. 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 images
Resolution: The user does not have the permission to delete images. Contact your system administrator.
INVALID_DATAHTTP 400
the id given seems to be invalid
Resolution: The record ID specified in the URL is invalid. Refer to Get Records API to get valid record IDs.
RECORD_LOCKEDHTTP 400
You cannot perform this operation as the record is locked.
Resolution: Please wait until the record is unlocked.

Sample Response

Copied{
    "code": "SUCCESS",
    "details": {},
    "message": "Photo deleted",
    "status": "success"
}