Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/toolbox-team/reddit-moderator-toolbox/llms.txt

Use this file to discover all available pages before exploring further.

Toolbox stores subreddit-specific configuration in the toolbox wiki page of each subreddit. This wiki-based approach means every moderator on the team reads from the same source of truth — there is no per-user copy of subreddit config. Any moderator with wiki edit access can update the configuration, and the changes take effect for all team members immediately.

Where config is stored

Toolbox reads and writes subreddit configuration to:
/r/<subreddit>/wiki/toolbox
The config is stored as a JSON object. Toolbox validates the schema version on every read. The current config schema version is 1, defined in tbcore.js as configSchema. Toolbox will reject configs whose ver field falls outside the range [configMinSchema, configMaxSchema], both of which are also 1.
Toolbox does not create the wiki page automatically. The page is created the first time a moderator saves subreddit-specific config through the Toolbox settings panel.

Who can configure subreddit settings

Only Reddit users who are moderators of a subreddit with wiki edit permissions can modify Toolbox subreddit config. Toolbox uses the standard Reddit wiki API to read and write the toolbox page, so all of Reddit’s normal wiki access controls apply.
Moderators without wiki edit access can still read and use subreddit config (e.g., view and apply removal reasons), but they cannot save changes.

What subreddit config includes

Removal reasons

An ordered list of templated removal messages. Each reason has a title, markdown body, optional flair text and CSS class, and flags for whether it applies to posts, comments, or both.

Usernote types

Custom note categories with display labels and colors. Each type maps to a color key used to render note badges in the mod UI.

Domain taggers

Rules that highlight or tag links from specific domains in the post queue. Useful for flagging known spam or trusted news domains.

Mod bar config

Subreddit-level defaults for mod bar behavior, including custom queue links and visibility settings shared across the mod team.

Removal defaults

Default delivery method, sticky behavior, lock-on-removal, log subreddit, PM subject line, and header/footer text used by the removal reasons dialog.

Get-from delegation

A getfrom field on removal reasons and other config blocks that tells Toolbox to load that section from a different subreddit’s config. Used by mod teams managing multiple communities with a shared setup.

How to access and edit subreddit config

1

Open the Toolbox settings panel

Click the gear icon in the Toolbox mod bar on any page in the subreddit you want to configure.
2

Navigate to a subreddit-specific module

Select a module that has per-subreddit config, such as Removal Reasons or Usernotes. A subreddit selector will appear at the top of that section.
3

Choose the subreddit

Pick the subreddit you want to configure from the dropdown. Toolbox loads the current config from that subreddit’s toolbox wiki page.
4

Make your changes and save

Edit the config fields and click Save. Toolbox writes the updated JSON back to the wiki page. All moderators on the subreddit will see the new config on their next page load.

Config schema versioning

The ver field at the top level of the config JSON identifies the schema version. Toolbox uses this to ensure backward compatibility.
ConstantValueMeaning
configSchema1Current schema version written by Toolbox
configMinSchema1Minimum schema version Toolbox will accept
configMaxSchema1Maximum schema version Toolbox will accept
If you manually edit the toolbox wiki page and set ver to a value outside [1, 1], Toolbox will refuse to load the config and log a version check failure. Always leave the ver field set to 1.

Build docs developers (and LLMs) love