Skip to main content

removeFromBlocklist

This method removes an item from the Blocklist, identified by its ID.

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 has type blocklist rules.

Parameters

Parameter

Description

Included in request

Type

Values

companyId

The ID of the company to which the Blocklist item belongs to.

Optional

String

Must be a valid company ID that the user has access to.

Default value: the company the API key used to make the request belongs to.

params

Indicates the items you want to remove from the blocklist rule.

Mandatory

Object

Refer to params.

Objects

params

Parameter

Description

Included in request

Type

Values

id

The ID of the item you want to remove.

Mandatory

Array of Strings

Must be valid blocklist item IDs that you have access to.

Return value

Attribute

Type

Description

result

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

{
  "params": {
	"ids": ['6605882651f1f25d2708d2d7', '6605882651f1f25d2708d2d8'],
  },
  "jsonrpc": "2.0",
  "method": "removeFromBlocklist",
  "id": "5087eab8-b74f-4a3e-85b3-4271e85890d5"
}

Version 1.0

Parameters

Parameter

Type

Optional

Description

hashItemId

String

No

the ID of the item in the Blocklist to be deleted

Return value

This method returns a 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
   }