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 subreddit configuration is stored as plain JSON in the toolbox wiki page. It holds removal reasons, custom usernote type definitions, ban macros, and mod macros for the subreddit. Unlike usernotes, the config is not compressed. Wiki page: toolbox | Schema version: 1 | Supported range: v1 only

​
Top-level structure

{
  "ver": 1,
  "domainTags": {},
  "removalReasons": {
    "header": "Your post was removed for the following reason(s):\n\n",
    "footer": "\n\nIf you have questions, message the moderators.",
    "reasons": []
  },
  "usernoteColors": [],
  "banMacros": {},
  "modMacros": []
}
​
ver
integer
required
Schema version. Always 1. Toolbox rejects config objects with any other value.
​
domainTags
object
Domain tagging rules used by Toolbox’s domain tagger feature. Keys are domain strings; values are tag configuration objects. An empty object {} or empty string "" means domain tagging is not configured.
​
removalReasons
object
Container for the subreddit’s removal reason templates.
​
usernoteColors
object[]
Array of custom note type definitions that override the Toolbox defaults. Each entry defines a key, display color, and display text. See note type object below.
​
banMacros
object
Ban reason templates. Keys are macro names; values are template strings. Supports the same {author}, {subreddit}, and {kind} placeholders as removal reasons.
​
modMacros
object[]
Array of moderator macro definitions used for quick-action buttons in the Toolbox mod bar. Structure mirrors removal reasons but applied to mod actions rather than removals.

​
Removal reason object

Each entry in removalReasons.reasons follows this structure: 
{
  "id": "reason-spam-001",
  "title": "Spam",
  "text": "Your submission was removed because it appears to be spam. {subreddit} does not allow self-promotional posts.",
  "flairText": "Removed: Spam",
  "flairCSS": "removed-spam",
  "flairTemplateID": "",
  "sticky": false,
  "distinguish": true,
  "removedFrom": ["post", "comment"]
}
​
id
string
required
Unique identifier for this removal reason within the subreddit. Used to reference reasons from other systems.
​
title
string
required
Human-readable name shown in the Toolbox removal reason selector.
​
text
string
required
The body of the removal message. Supports template placeholders: {author} (username), {subreddit} (subreddit name), {kind} (post or comment), {title} (submission title), {url} (submission URL), {domain} (link domain).
​
flairText
string
Flair text to apply to the removed submission.
​
flairCSS
string
CSS class for old-Reddit flair to apply to the removed submission.
​
flairTemplateID
string
New Reddit flair template ID to apply instead of CSS-based flair.
​
sticky
boolean
Whether to sticky the removal reason comment.
​
distinguish
boolean
Whether to distinguish the removal reason comment as a moderator comment.
​
removedFrom
string[]
Contexts where this reason applies. Values are "post" and/or "comment".

​
Note type object

Entries in usernoteColors override the built-in note types. If this array is populated, Toolbox uses it instead of the defaults for this subreddit: 
{
  "key": "newtype",
  "color": "blue",
  "text": "Helpful User"
}
​
key
string
required
Internal identifier stored in constants.warnings in the usernotes wiki page.
​
color
string
required
CSS color name or hex value used for the note badge in the Toolbox UI.
​
text
string
required
Human-readable label shown in the usernote type selector.

​
Full config example

{
  "ver": 1,
  "domainTags": {},
  "removalReasons": {
    "header": "Hello u/{author}, your submission has been removed:\n\n",
    "footer": "\n\nQuestions? [Message the moderators](/message/compose?to=/r/{subreddit}).",
    "reasons": [
      {
        "id": "rule1-spam",
        "title": "Rule 1 — Spam",
        "text": "Your {kind} was removed because it violates our spam policy.",
        "flairText": "Removed",
        "flairCSS": "",
        "flairTemplateID": "",
        "sticky": false,
        "distinguish": true,
        "removedFrom": ["post", "comment"]
      }
    ]
  },
  "usernoteColors": [
    {"key": "gooduser", "color": "green", "text": "Good Contributor"},
    {"key": "ban", "color": "red", "text": "Ban"},
    {"key": "permban", "color": "darkred", "text": "Permanent Ban"}
  ],
  "banMacros": {
    "Spam": "Banned for spamming in /r/{subreddit}."
  },
  "modMacros": []
}

Build docs developers (and LLMs) love

Get started for freeTalk to us