# Update account BoxTrapper blocklist

This function sets the BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.

Important:

When you disable the
Receive Mail role,
the system disables this function.

Endpoint: GET /BoxTrapper/set_blocklist
Version: 11.136.0.25
Security: BasicAuth

## Query parameters:

  - `email` (string, required)
    A valid email address on the cPanel account.

Warning:

If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.
    Example: "user@example.com"

  - `rules` (array, required)
    An array of blocklist rules.

Note:

You can set multiple block rules, duplicate or increment the parameter name. For example,
rules-1, rules-2, and rules-3.

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "set_blocklist"

  - `module` (string)
    The name of the module called.
    Example: "BoxTrapper"

  - `result` (object)

  - `result.data` (object,null)

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.status` (integer)
    * 1 - Success.
* 0 - Failed. Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.