---
title: "Update SpamAssassin™ settings"
method: GET
path: "/SpamAssassin/update_user_preference"
tags: ["SpamAssassin", "Spam Management"]
---

# Update SpamAssassin™ settings

`GET /SpamAssassin/update_user_preference`

This function sets the Apache SpamAssassin™ settings for the account.

**Note:**

Additional customizations may appear in the function's return. For more information,
read the [Apache SpamAssassin configuration file documentation](https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences).

## Query parameters

- `preference` string, required
- `value` string

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `additionalProperties` string[] — An array containing custom SpamAssassin variable values. **Note:** The array's name is the custom SpamAssassin variable's name.
      - `blacklist_from` string[] — An array of email addresses on the blacklist.
      - `required_score` number[] — An array containing the score at which the system will mark a message as spam. The system considers mail that matches this score to be spam.
      - `score` string[] — An array of the symbolic test names and their scores.
      - `whitelist_from` string[] — An array of the email addresses on the whitelist.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)