Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/scoring_rules/{rule_id}/actions/activate

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.scoring_rules.ALL
(or)
scope=ZohoCRM.settings.scoring_rules.{operation_type}

Possible operation types

ALL - Full access to scoring rules
UPDATE - Update scoring rules

Note

The HTTP request method for activating a scoring rule is PUT, and DELETE is used to deactivate a rule.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/settings/automation/scoring_rules/4876876000000965528/actions/activate"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X PUT

Possible Errors

  • 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 above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.settings.scoring_rules.UPDATE scope. Create a new client with valid scope. Refer to scope section above for more details.

  • NO_PERMISSIONHTTP 403

    Permission denied to update
    Resolution: The user does not have permission to update scoring rules data. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

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

  • 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 endpoints section above.

  • ACTIVE_STATE_LIMIT_EXCEEDEDHTTP 400

    You have exceeded the number of active rules possible for your account.
    Resolution: Limit the number of active rules to be within the permissible limit. Refer to the limits for more details.

Sample Response

CopiedFor activation request:
{
    "scoring_rules": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4876876000000965528"
            },
            "message": "scoring rule activated successfully",
            "status": "success"
        }
    ]
}

For deactivation request:
{
    "scoring_rules": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4876876000000965528"
            },
            "message": "scoring rule deactivated successfully",
            "status": "success"
        }
    ]
}