Delete Webhooks

Purpose

To delete one or more webhooks configured in your Zoho CRM account. You can delete up to 10 webhooks in a single API call.

Endpoints

DELETE /settings/automation/webhooks/{webhook_ID}
DELETE /settings/automation/webhooks?ids={webhook_ID_1},{webhook_ID_2},...

Request Details

Request URL

To delete a single webhook:
{api-domain}/crm/{version}/settings/automation/webhooks/{webhook_ID}
To delete multiple webhooks:
{api-domain}/crm/{version}/settings/automation/webhooks?ids={webhook_ID_1},{webhook_ID_2},...

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.automation_actions.DELETE
or
ZohoCRM.settings.automation_actions.ALL
or
ZohoCRM.settings.ALL

Parameters

idsstring, mandatory, if you want to delete multiple webhooks
Specify the webhook IDs that need to be deleted. Use the Get Webhooks API to retrieve all available webhook IDs. A maximum of 10 webhooks can be deleted in a single API call.

Note

You cannot delete webhooks if they are associated with any automation features such as workflows, blueprints, or approval processes.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/webhooks/5725767000007098001"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

INVALID_DATAHTTP 400
The webhook ID given in the URL seems to be invalid
Resolution: Specify a valid webhook ID. Use the Get Webhooks API to retrieve the available webhook IDs.
NO_CONTENTHTTP 200
No webhook available
Resolution: Specify a valid webhook ID.
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 the Endpoints section.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to delete webhooks. Create a new token with valid scope. Refer to the Scope section for details.
AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call.
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 for details.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
    "webhooks": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5725767000007098001"
            },
            "message": "Webhook is deleted",
            "status": "success"
        }
    ]