Get Workflow Rules Count by Module

Purpose

To retrieve the count of active and total Workflow Rules configured for each module in your Zoho CRM account.

Endpoints

GET /settings/automation/workflow_rules/actions/module_specific_count

Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/workflow_rules/actions/module_specific_count

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/workflow_rules/actions/module_specific_count"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Response JSON

module_specific_countJSON array
Contains the list of modules and their workflow rule counts.
- moduleJSON object
  Represents the module for which the rule counts are provided.
- active_rules_configuredinteger
  Represents the number of workflow rules currently active for the module.
- total_rules_configuredinteger
  Represents the total number of workflow rules configured for the module.

Possible Errors

INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: This API supports only the GET method. Retry the request using the GET method.
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{
    "module_specific_count": [
        {
            "active_rules_configured": 2,
            "module": {
                "api_name": "Contacts",
                "id": "4876876000000002179"
            },
            "total_rules_configured": 3
        },
        {
            "active_rules_configured": 2,
            "module": {
                "api_name": "Appointments__s",
                "id": "4876876000002362026"
            },
            "total_rules_configured": 3
        },
        {
            "active_rules_configured": 2,
            "module": {
                "api_name": "Calls",
                "id": "4876876000000033015"
            },
            "total_rules_configured": 3
        },
        {
            "active_rules_configured": 21,
            "module": {
                "api_name": "Leads",
                "id": "4876876000000002175"
            },
            "total_rules_configured": 21
        },
        {
            "active_rules_configured": 3,
            "module": {
                "api_name": "Emails",
                "id": "4876876000000014163"
            },
            "total_rules_configured": 4
        }
    ]
}