Data Sharing Rules Summary

Purpose

To get module-wise data on count and running status of sharing rules in your Zoho CRM organization.

Endpoints

GET /settings/data_sharing/rules/actions/summary

Request Details

Request URL

{api-domain}/crm/{version}/settings/data_sharing/rules/actions/summary

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.data_sharing.READ

Supported modules

Leads, Accounts, Contacts, Deals, Tasks, Meetings, Calls, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom modules

Sample Request

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

Response JSON

module JSON object
Represents api name and the unique identifier of the module.
rule_computation_status Boolean
Indicates whether the rule is currently in running status for the records of the module
Possible values:
true
false
rule_count integer
Represents the number of sharing rules configured for the module.

Possible Errors

NO CONTENTHTTP 204
When sharing rules are not present.
INVALID_REQUEST_METHODHTTP 400
The request method is incorrect.
Resolution: Use the HTTP GET method to make this API call. Any other request method will result in this error.
OAUTH_SCOPE_MISMATCHHTTP 401
The access token you have used to make this API call does not have the required scope.
Resolution: Generate a new access token with the required scopes for this API. Refer to Scope section at the beginning of this page for the list of required scopes.
NO_PERMISSIONHTTP 403
You do not have Modules Customization permission.
Resolution: Get permission for the Modules Customization.
INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to request URL section at the beginning of this page for more details.
INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in the server.
Resolution: Contact the support team at support@zohocrm.com.

Sample Response

Copied{
    "sharing_rules_summary": [
        {
            "module": {
                "api_name": "Leads",
                "id": "3602353000000000125"
            },
            "rule_computation_status": true,
            "rule_count": 5
        },
        {
            "module": {
                "api_name": "Contacts",
                "id": "3602353000000000129"
            },
            "rule_computation_status": false,
            "rule_count": 1
        },
        {
            "module": {
                "api_name": "Accounts",
                "id": "3602353000000000127"
            },
            "rule_computation_status": false,
            "rule_count": 1
        },
        {
            "module": {
                "api_name": "Deals",
                "id": "3602353000000000131"
            },
            "rule_computation_status": false,
            "rule_count": 1
        },
        {
            "module": {
                "api_name": "Tasks",
                "id": "3602353000000000143"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Events",
                "id": "3602353000000000145"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Calls",
                "id": "3602353000000017015"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Products",
                "id": "3602353000000000163"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Quotes",
                "id": "3602353000000000169"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Sales_Orders",
                "id": "3602353000000000171"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Purchase_Orders",
                "id": "3602353000000000173"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Invoices",
                "id": "3602353000000000175"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Campaigns",
                "id": "3602353000000000133"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Vendors",
                "id": "3602353000000000165"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Price_Books",
                "id": "3602353000000000167"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Cases",
                "id": "3602353000000000159"
            },
            "rule_computation_status": false,
            "rule_count": 0
        },
        {
            "module": {
                "api_name": "Solutions",
                "id": "3602353000000000161"
            },
            "rule_computation_status": false,
            "rule_count": 0
        }
    ]
}