Delete Workflow Rules

Purpose

To delete one or more Workflow rules from Zoho CRM. You can delete up to ten Workflow rules in a single API call.

Endpoints

  • DELETE /settings/automation/workflow_rules?module={module_API_name}&ids={id1, id2, id3, ..}
  • DELETE /settings/automation/workflow_rules/{workflow_rule_id}

Request Details

Request URL

To delete a specific Workflow Rule:
{api-domain}/crm/{version}/settings/automation/workflow_rules/{workflow_rule_id}

To delete multiple Workflow Rules by their ID:
{api-domain}/crm/{version}/settings/automation/workflow_rules?module={module_API_name}&ids={id1, id2, id3, ..}
 

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.workflow_rules.ALL
(or)
ZohoCRM.settings.workflow_rules.DELETE

Parameters
  • idsstring, mandatory for deleting multiple Workflow rules

    Specify the unique IDs of Workflow rule(s) that you want to delete. Pass up to ten Workflow rule IDs, in a comma separated format.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/workflow_rules?module=Leads&ids=4876876000011155001,4876876000011155026,4876876000011156001"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE

Note

  • When multiple Workflow Rule IDs are passed, if some deletions succeed and others fail, the API responds with 207 Multi-Status. Check the status key in each response item to see the result of each deletion.

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: This API supports only the DELETE method. Retry the request using the DELETE method.

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameter is missing
    Resolution: Pass the ids parameter in the API request. This is a mandatory parameter for this API call.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have the required OAUTH SCOPE. Create a new token with valid scope. Refer to the Scope section for more details.

  • 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 more details.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Response

Copied{
    "workflow_rules": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4876876000011155001"
            },
            "message": "WorkFlow Rule deleted successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "4876876000011155026"
            },
            "message": "WorkFlow Rule deleted successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "4876876000011156001"
            },
            "message": "WorkFlow Rule deleted successfully",
            "status": "success"
        }
    ]
}