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.

User Notes lets your mod team attach persistent, color-coded notes to any Reddit account directly from posts, comments, user hovercards, and ban/contributor pages. Notes are stored in your subreddit’s wiki and are immediately visible to every moderator who has Toolbox installed — no external spreadsheets or shared documents required.

​
How it works

When Toolbox detects an author element on a page you moderate, it injects a small clickable tag next to the username. If the user has existing notes, the tag shows a truncated preview of the most recent note, colored according to its note type. Clicking the tag opens a dialog where you can view the full history, add new notes, and delete individual entries. Notes are stored as versioned JSON in r/SUBREDDIT/wiki/usernotes. Each save creates a new wiki revision, giving you a complete audit trail of all changes. The current schema version is 6.
Toolbox reads notes from the wiki on first access and caches them in the session. The cache is refreshed automatically when you save or delete a note.

​
Adding and editing notes

1

Click the note tag next to a username

On any page you moderate, Toolbox adds a bracketed tag — showing N for users with no notes or a preview of the latest note text for users who have notes. Click it to open the User Notes dialog.
2

Select a note type

In the dialog, choose one of the color-coded note types displayed as a row of labeled options. Clicking a selected type deselects it, leaving the note without a type. Note types and their colors are configurable per-subreddit.
3

Write the note text

Type your note into the input field. You can also check Include link to attach a permalink to the current post or comment, which appears as a clickable link on the note when viewed later. Press Enter or click Save to save.
4

Review and delete older notes

The dialog lists all existing notes in reverse-chronological order, showing the note text, type, author (the mod who wrote it), and a relative timestamp. Click the delete icon on any row to remove that individual note.
Deleting a note is permanent. Toolbox writes the deletion immediately to the subreddit wiki. The wiki revision history retains a record of the previous state, but Toolbox itself does not provide an undo action.

​
Default note types

Toolbox ships with seven built-in note types. Subreddit moderators can replace these with custom types and colors through the Toolbox subreddit configuration.
KeyDisplay textColor
gooduserGood Contributorgreen
spamwatchSpam Watchfuchsia
spamwarnSpam Warningpurple
abusewarnAbuse Warningorange
banBanred
permbanPermanent Bandarkred
botbanBot Banblack

​
Usernotes manager

The manager lets you view, search, filter, and bulk-manage all notes across a subreddit in one overlay.
1

Open the manager

When unManagerLink is enabled (the default), an edit usernotes link appears in the mod context menu on any subreddit page you moderate. Click it to open the manager overlay.
2

Search and filter

The manager shows the total number of users with notes and the total note count. Use the search for user field to filter by username, the search for note contents field to filter by note text, and the type dropdown to filter by note type. Results update as you type.
3

Delete notes or users

Each note row has a delete icon to remove that individual note. Each user section has a delete icon to remove all notes for that user. You can also refresh the displayed account status to confirm whether an account is still active.
4

Prune notes in bulk

Click Prune deleted/suspended profiles to open the pruning dialog. You can prune notes older than a selected age (6 months, 1 year, 2, 3, or 4 years), notes for deleted accounts, notes for permanently suspended accounts, or notes for accounts that have been inactive for a selected period. Toolbox displays a confirmation summary before writing any changes.
The manager displays 50 users per page. Use the pager controls at the bottom of the overlay to navigate through larger note databases.

​
Notes on mod pages

When showOnModPages is enabled, Toolbox also displays the current usernote tag on ban pages, contributor pages, and moderator management pages (/about/banned, /about/contributors, /about/moderators). This lets you see at a glance whether a user you are acting on has existing notes.

​
Wiki storage format

Notes are stored in r/SUBREDDIT/wiki/usernotes as a compressed JSON object. The structure uses a constants pool to deduplicate mod usernames and note type keys, reducing the size of the stored blob. Toolbox handles schema migration automatically — if it detects an older schema version (minimum supported: v4), it prompts you to upgrade. Schema v6 uses zlib compression on the users object. 
{
  "ver": 6,
  "constants": {
    "users": ["mod_username"],
    "warnings": ["ban", "spamwarn"]
  },
  "blob": "<zlib-compressed JSON string>"
}
If you are building a third-party mod tool that reads usernotes, refer to the inflateNotes and decompressBlob logic in usernotes.js for the full schema decompress-and-inflate pipeline.

​
Settings reference

Type: boolean
Default: falseWhen enabled, the inline note preview tag next to usernames includes the date the most recent note was created, formatted as a locale-appropriate short date string (e.g. spam warning (5/9/2026)).
Type: boolean
Default: falseWhen enabled, Toolbox displays the current usernote tag on subreddit management pages: the ban list (/about/banned), contributor list (/about/contributors), and moderator list (/about/moderators).
Type: number
Default: 20Controls how many characters of the most recent note text are shown in the inline preview tag before the text is truncated with an ellipsis. The date, if enabled via showDate, is appended after this limit and does not count toward it.
Type: boolean
Default: inherits from the GenSettings module setting onlyshowInhoverHidden setting that mirrors the global Toolbox preference for showing user-related controls only in hover cards rather than inline on posts and comments. When true, note tags are only injected into user hovercards, not into author links throughout the page.

Build docs developers (and LLMs) love

Get started for freeTalk to us