Custom Buttons
Purpose
To delete a custom button.
Request Details
Request URL
{api-domain}/crm/{version}/settings/custom_buttons/{custom_button_id}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.custom_buttons.DELETE
Scope
scope=ZohoCRM.settings.custom_buttons.DELETE (or)
scope=ZohoCRM.settings.custom_buttons.ALL
Sample Request
Copied"https://www.zohoapis.com/crm/v7/settings/custom_buttons/2423488000000635115?module=leads
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Parameter
- modulestring, mandatory
Specify the API name of the required module. For example, Leads, Contacts, Accounts, Deals, and so on.
Possible Errors
- REQUIRED_PARAM_MISSING HTTP 400
You have not specified the module in the request.
Resolution: Specify a module name. - 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 above. - INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name.
Specify a valid module name. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have Zohocrm.settings.custom_buttons.DELETE. Create a new client with valid scope. Refer to scope section above. - 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 the request URL section above. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.
Sample Response
Copied{
"custom_buttons": [
{
"code": "SUCCESS",
"details": {
"id": "2423488000000635115"
},
"message": "custom button deleted successfully",
"status": "success"
}
]
}