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.

Removal Reasons lets you define a library of templated messages for your subreddit and send them automatically when you remove a post or comment. When a moderator clicks Remove, Toolbox intercepts the action and shows a dialog where they can select one or more reasons, choose how to deliver the message, and send — all without leaving the page. Reason templates, delivery options, headers, and footers are stored in the subreddit’s Toolbox configuration wiki page so every moderator on the team shares the same library.

​
How the removal dialog works

1

Click Remove on a post or comment

Toolbox intercepts clicks on remove buttons across old Reddit, new Reddit, and Toolbox-generated elements. The removal dialog opens automatically if removal reasons are configured for the subreddit. Hold Shift while clicking Remove to skip the dialog and remove without sending a reason.
2

Select one or more reasons

The dialog lists all configured removal reasons in a table. Each row shows the reason title, the formatted reason body (collapsed when a title exists), and optional flair text and CSS class columns. Click a row to select it. Multiple reasons can be selected; their text is concatenated in order.You can reorder reasons within the dialog using the up/down sort arrows on each row, which rearranges them for the current removal only.
3

Choose a delivery method

Select how to send the removal message using the radio buttons in the dialog:
  • Reply with a comment — posts a distinguished reply to the removed item. Optional sub-options: sticky the comment, lock the comment, and send as /u/SUBREDDIT-ModTeam.
  • Send as PM — sends a personal message to the author. Optional sub-options: send via modmail as /r/SUBREDDIT (which will appear in modmail), and auto-archive the sent modmail conversation.
  • Send as both PM and reply — combines both delivery methods.
  • None — logs the removal to a log subreddit without sending any message to the author (only available when a log subreddit is configured).
The delivery method defaults to the per-subreddit configuration. If the subreddit config sets removalOption to force, the delivery method is locked and the radio buttons are disabled.
4

Optionally include header and footer

If the subreddit has a configured header or footer, each appears in the dialog with a checkbox. Both are included by default; uncheck either to exclude it from the sent message.
5

Click Send

Toolbox removes the item (if not already removed), sends the message via all selected delivery channels, applies any flair if configured on the selected reason, and optionally posts a log entry to the configured log subreddit.Click No reason to dismiss the dialog without sending anything. Click Cancel and approve to dismiss the dialog and approve the item.
Direct PM delivery is currently broken. Reddit removed compatibility for first-party session-based /message/compose requests, and Toolbox does not have its own OAuth app to work around this. Selecting PM-only delivery will throw an error. Use the Send via new modmail as /r/SUBREDDIT option instead, which routes the message through Reddit’s modmail system.

​
Template placeholders

Removal reason text, the PM subject line, the log post title, and the ban title all support placeholder tokens that Toolbox substitutes at send time using data from the removed item.
PlaceholderReplaced with
{subreddit}The subreddit name
{author}The Reddit username of the content author
{kind}submission or comment depending on the item type
{title}The post title (submissions only)
{url}The permalink to the removed item
{link}The direct link to the post (for link submissions)
{domain}The domain of the linked URL
{mod}The moderator performing the removal
{body}The body text of the post or comment
{uri_body}URL-encoded version of {body}
{uri_title}URL-encoded version of {title}
{loglink}URL of the log post created in the log subreddit (if configured)
{reason}The log reason text entered in the Log Reason field
The default PM subject is Your {kind} was removed from /r/{subreddit}. The default log post title is Removed: {kind} by /u/{author} to /r/{subreddit}. The default ban title is /u/{author} has been banned from /r/{subreddit} for {reason}.
Reason bodies support full Reddit markdown. You can also embed <input>, <select>, and <textarea> HTML elements directly in a reason template to create fill-in fields that appear in the removal dialog. Toolbox caches the last-used values for these inputs.

​
Subreddit configuration

Removal reasons are stored in the subreddit’s Toolbox config wiki page under removalReasons. Each subreddit can define:

Reason library

An ordered array of reason objects, each with title, text (markdown body), optional flairText, flairCSS, and flairTemplateID. Reasons can be scoped to posts only (removePosts: true) or comments only (removeComments: true).

Header and footer

A global header and footer (markdown) that wrap every removal message. Both are optional and can be toggled per-removal in the dialog.

PM subject line

A custom subject line for PM and modmail deliveries. Supports placeholder tokens. Defaults to Your {kind} was removed from /r/{subreddit}.

Log subreddit

A subreddit where Toolbox posts a link to each removed item for logging purposes. The log post title is configurable and supports {reason} for a free-text log reason field in the dialog.

Delivery defaults

Per-subreddit defaults for delivery type (typeReply), sticky (typeStickied), send as ModTeam (typeCommentAsSubreddit), lock comment (typeLockComment), send as subreddit (typeAsSub), auto-archive modmail (autoArchive), lock thread (typeLockThread), and removal enforcement (removalOption: force).

Get-from delegation

A getfrom field that causes Toolbox to load removal reasons from a different subreddit’s config. Useful for mod teams managing multiple communities with a shared reason library.

​
Comment reasons for removed comments

By default, the removal reasons dialog only appears when removing posts. Enable the commentReasons setting to also show the dialog when removing comments. When enabled, reasons with removeComments set to true appear for comment removals. Reasons with removeComments set to undefined (the default for older reason configs) appear for both posts and comments.

​
Settings reference

Type: boolean
Default: falseWhen enabled, the removal reasons dialog also appears when you remove a comment. Reasons with removeComments: true or removeComments: undefined (legacy) are shown for comment removals.
Type: boolean
Default: falseWhen enabled, Toolbox displays the removal dialog even on subreddits that have no removal reasons configured, showing a blank custom text area. This lets you write a one-off free-text reason without a pre-configured library.
Type: selector
Default: reply
Options: Reply with a comment to the item that is removed, Send as PM (personal message), Send as both PM and reply, None (This only works when a logsub has been set)Sets the default delivery method shown pre-selected in the removal dialog. If the subreddit configuration specifies a delivery method (typeReply), that value takes precedence over this setting for that subreddit.
Type: boolean
Default: falseWhen enabled, PMs are sent via modmail on behalf of /r/SUBREDDIT rather than from your personal account. This will create entries in modmail that may clutter the modmail view.
Type: boolean
Default: falseWhen enabled, Toolbox automatically archives the modmail conversation created by a PM delivery immediately after sending. Only works with new modmail.
Type: boolean
Default: falseWhen enabled, comment-type removal replies are stickied to the top of the post. Only applies to submission removals, not comment removals.
Type: boolean
Default: falseWhen enabled, removal reason comments are posted using the /u/SUBREDDIT-ModTeam shared account via Reddit’s removal_link_message or removal_comment_message modaction endpoints.
Type: boolean
Default: falseWhen enabled, Toolbox locks the removed submission after sending the removal reason. Only applies to submissions.
Type: boolean
Default: falseWhen enabled, the removal reason comment posted as a reply is locked immediately after being distinguished.

Build docs developers (and LLMs) love

Get started for freeTalk to us