removeFromBlocklist
This method removes one or more items from the Blocklist, identified by their IDs.
Important
This method has been updated to version 1.2. For information applicable to version 1.0, refer to this section.
You can only use version 1.0 to remove hash-type blocklist rules.
Parameters
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| The IDs of the items you want to remove from the Blocklist. | Mandatory | Array of strings | Must be the valid IDs of Blocklist items that you have access to. |
These are common parameters, available across all public API methods:
Parameter | Description | Included in request | Type | Value requirements |
|---|---|---|---|---|
| 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 | The only possible value is |
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Return value
Attribute | Type | Description |
|---|---|---|
| Boolean | Indicates if the operation was successful. |
Examples
Request
{
"params": {
"ids": [
"6605882651f1f25d2708d2d7",
"6605882651f1f25d2708d2d8"
]
},
"jsonrpc": "2.0",
"method": "removeFromBlocklist",
"id": "5087eab8-b74f-4a3e-85b3-4271e85890d5"}Response
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"result": true
} Version 1.0
Parameters
Parameter | Type | Included in request | Description |
|---|---|---|---|
| String | Mandatory | The ID of the item in the Blocklist to be deleted. |
These are common parameters, available across all public API methods:
Parameter | Description | Included in request | Type | Value requirements |
|---|---|---|---|---|
| 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 | The only possible value is |
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Return value
This method returns a result Boolean which is true if the operation was successful.
Example
Request:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"method": "removeFromBlocklist",
"params": {
"hashItemId" : "5b680f6fb1a43d860a7b23c1"
}
} Response:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"result": true
}