deleteCustomRule
Method to delete a custom rule.
Parameters
Parameter | Type | Optional | Description and value requirements |
|---|---|---|---|
| Integer | Yes | The type of the rule to be deleted. Possible values:
Default value: |
| String | No | The ID of the rule to be deleted. The value must be a 24-character hexadecimal string. |
These are common parameters, available across all public API methods:
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking. | Mandatory | String | No additional requirements. |
| The name of the method you are using to send the request. | Mandatory | String | Must be a valid method name. |
| The version of JSON-RPC used by the request and the response. | Mandatory | String | Possible values:
|
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Return value
This method returns a boolean value, which is true if the deletion of the custom rule was successful.
Example
Request:
{
"params": {
"ruleId": "6182a7e26f59d3072a1e8fc5",
"type": 1
},
"jsonrpc": "2.0",
"method": "deleteCustomRule",
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
} Response:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"result": true
}