Reddit organizes discussions into subreddits. Use this integration to read or search posts and comments, submit posts and replies, manage messages, and inspect users and communities. Moderator actions are listed separately in the reference below.
Sim requests these scopes when someone connects a Reddit account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.
Setting Value Redirect URI <NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/redditEnvironment variables REDDIT_CLIENT_ID, REDDIT_CLIENT_SECRET
Scope Description identityView your Reddit username and signup date readRead posts and comments through your account submitSubmit posts and comments voteVote on posts and comments saveSave and unsave posts and comments editEdit and delete your posts and comments subscribeSubscribe and unsubscribe from subreddits historyView your voting history and saved or hidden posts privatemessagesAccess inbox and send private messages accountUpdate account preferences and settings mysubredditsAccess subscribed and moderated subreddits flairSelect your user flair and change flair on your posts reportReport content and hide or show posts modpostsApprove, remove, and moderate posts in moderated subreddits modflairManage flair in moderated subreddits modmailAccess and respond to moderator mail
Read posts, comments, and search content. Submit posts, vote, reply, edit, manage messages, and access user and subreddit info.
Fetch posts from a subreddit with different sorting options
Parameter Type Required Description subredditstring Yes The subreddit to fetch posts from (e.g., "technology", "news") sortstring No Sort method for posts (e.g., "hot", "new", "top", "rising", "controversial"). Default: "hot" limitnumber No Maximum number of posts to return (e.g., 25). Default: 10, max: 100 timestring No Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" (default: "all") afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all") sr_detailboolean No Expand subreddit details in the response gstring No Geo filter for posts (e.g., "GLOBAL", "US", "AR", etc.)
Parameter Type Description subredditstring Name of the subreddit where posts were fetched from postsarray Array of posts with title, author, URL, score, comments count, and metadata ↳ id string Post ID ↳ name string Thing fullname (t3_xxxxx) ↳ title string Post title ↳ author string Author username ↳ url string Post URL ↳ permalink string Reddit permalink ↳ score number Post score (upvotes - downvotes) ↳ num_comments number Number of comments ↳ created_utc number Creation timestamp (UTC) ↳ is_self boolean Whether this is a text post ↳ selftext string Text content for self posts ↳ thumbnail string Thumbnail URL ↳ subreddit string Subreddit name afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Fetch comments from a specific Reddit post
Parameter Type Required Description postIdstring Yes The ID of the Reddit post to fetch comments from (e.g., "abc123") subredditstring Yes The subreddit where the post is located (e.g., "technology", "programming") sortstring No Sort method for comments: "confidence", "top", "new", "controversial", "old", "random", "qa" (default: "confidence") limitnumber No Maximum number of comments to return (e.g., 25). Default: 50, max: 100 depthnumber No Maximum depth of subtrees in the thread (controls nested comment levels) contextnumber No Number of parent comments to include showeditsboolean No Show edit information for comments showmoreboolean No Include "load more comments" elements in the response threadedboolean No Return comments in threaded/nested format truncatenumber No Integer to truncate comment depth commentstring No ID36 of a comment to focus on (returns that comment thread)
Parameter Type Description postobject Post information including ID, title, author, content, and metadata ↳ id string Post ID ↳ name string Thing fullname (t3_xxxxx) ↳ title string Post title ↳ author string Post author ↳ selftext string Post text content ↳ score number Post score ↳ created_utc number Creation timestamp ↳ permalink string Reddit permalink commentsarray Nested comments with author, body, score, timestamps, and replies ↳ id string Comment ID ↳ name string Thing fullname (t1_xxxxx) ↳ author string Comment author ↳ body string Comment text ↳ score number Comment score ↳ created_utc number Creation timestamp ↳ permalink string Comment permalink ↳ replies array Nested reply comments
Fetch controversial posts from a subreddit
Parameter Type Required Description subredditstring Yes The subreddit to fetch posts from (e.g., "technology", "news") timestring No Time filter for controversial posts: "hour", "day", "week", "month", "year", or "all" (default: "all") limitnumber No Maximum number of posts to return (e.g., 25). Default: 10, max: 100 afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all") sr_detailboolean No Expand subreddit details in the response
Parameter Type Description subredditstring Name of the subreddit where posts were fetched from postsarray Array of controversial posts with title, author, URL, score, comments count, and metadata ↳ id string Post ID ↳ name string Thing fullname (t3_xxxxx) ↳ title string Post title ↳ author string Author username ↳ url string Post URL ↳ permalink string Reddit permalink ↳ score number Post score (upvotes - downvotes) ↳ num_comments number Number of comments ↳ created_utc number Creation timestamp (UTC) ↳ is_self boolean Whether this is a text post ↳ selftext string Text content for self posts ↳ thumbnail string Thumbnail URL ↳ subreddit string Subreddit name afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Search for posts within a subreddit
Parameter Type Required Description subredditstring Yes The subreddit to search in (e.g., "technology", "programming") querystring Yes Search query text (e.g., "artificial intelligence", "machine learning tutorial") sortstring No Sort method for search results (e.g., "relevance", "hot", "top", "new", "comments"). Default: "relevance" timestring No Time filter for search results: "hour", "day", "week", "month", "year", or "all" (default: "all") limitnumber No Maximum number of posts to return (e.g., 25). Default: 10, max: 100 restrict_srboolean No Restrict search to the specified subreddit only (default: true) afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all") typestring No Type of search results: "link" (posts), "sr" (subreddits), or "user" (users). Default: "link" sr_detailboolean No Expand subreddit details in the response
Parameter Type Description subredditstring Name of the subreddit where search was performed postsarray Array of search result posts with title, author, URL, score, comments count, and metadata ↳ id string Post ID ↳ name string Thing fullname (t3_xxxxx) ↳ title string Post title ↳ author string Author username ↳ url string Post URL ↳ permalink string Reddit permalink ↳ score number Post score (upvotes - downvotes) ↳ num_comments number Number of comments ↳ created_utc number Creation timestamp (UTC) ↳ is_self boolean Whether this is a text post ↳ selftext string Text content for self posts ↳ thumbnail string Thumbnail URL ↳ subreddit string Subreddit name afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Submit a new post to a subreddit (text or link)
Parameter Type Required Description subredditstring Yes The subreddit to post to (e.g., "technology", "programming") titlestring Yes Title of the submission (e.g., "Check out this new AI tool"). Max 300 characters textstring No Text content for a self post in markdown format (e.g., "This is the body of my post") urlstring No URL for a link post (cannot be used with text) nsfwboolean No Mark post as NSFW spoilerboolean No Mark post as spoiler send_repliesboolean No Send reply notifications to inbox (default: true) flair_idstring No Flair template UUID for the post (max 36 characters) flair_textstring No Flair text to display on the post (max 64 characters) collection_idstring No Collection UUID to add the post to
Parameter Type Description successboolean Whether the post was submitted successfully messagestring Success or error message dataobject Post data including ID, name, URL, and permalink ↳ id string New post ID ↳ name string Thing fullname (t3_xxxxx) ↳ url string Post URL from API response ↳ permalink string Full Reddit permalink
Upvote, downvote, or unvote a Reddit post or comment
Parameter Type Required Description idstring Yes Thing fullname to vote on (e.g., "t3_abc123" for post, "t1_def456" for comment) dirnumber Yes Vote direction: 1 (upvote), 0 (unvote), or -1 (downvote)
Parameter Type Description successboolean Whether the vote was successful messagestring Success or error message
Save a Reddit post or comment to your saved items
Parameter Type Required Description idstring Yes Thing fullname to save (e.g., "t3_abc123" for post, "t1_def456" for comment) categorystring No Category to save under (Reddit Gold feature)
Parameter Type Description successboolean Whether the save was successful messagestring Success or error message
Remove a Reddit post or comment from your saved items
Parameter Type Required Description idstring Yes Thing fullname to unsave (e.g., "t3_abc123" for post, "t1_def456" for comment)
Parameter Type Description successboolean Whether the unsave was successful messagestring Success or error message
Add a comment reply to a Reddit post or comment
Parameter Type Required Description parent_idstring Yes Thing fullname to reply to (e.g., "t3_abc123" for post, "t1_def456" for comment) textstring Yes Comment text in markdown format (e.g., "Great post! Here is my reply ") return_rtjsonboolean No Return response in Rich Text JSON format
Parameter Type Description successboolean Whether the reply was posted successfully messagestring Success or error message dataobject Comment data including ID, name, permalink, and body ↳ id string New comment ID ↳ name string Thing fullname (t1_xxxxx) ↳ permalink string Comment permalink ↳ body string Comment body text
Edit the text of your own Reddit post or comment
Parameter Type Required Description thing_idstring Yes Thing fullname to edit (e.g., "t3_abc123" for post, "t1_def456" for comment) textstring Yes New text content in markdown format (e.g., "Updated content here")
Parameter Type Description successboolean Whether the edit was successful messagestring Success or error message dataobject Updated content data ↳ id string Edited thing ID ↳ body string Updated comment body (for comments) ↳ selftext string Updated post text (for self posts)
Delete your own Reddit post or comment
Parameter Type Required Description idstring Yes Thing fullname to delete (e.g., "t3_abc123" for post, "t1_def456" for comment)
Parameter Type Description successboolean Whether the deletion was successful messagestring Success or error message
Subscribe or unsubscribe from a subreddit
Parameter Type Required Description subredditstring Yes The subreddit to subscribe to or unsubscribe from (e.g., "technology", "programming") actionstring Yes Action to perform: "sub" to subscribe or "unsub" to unsubscribe
Parameter Type Description successboolean Whether the subscription action was successful messagestring Success or error message
Get information about the authenticated Reddit user
Parameter Type Required Description
Parameter Type Description idstring User ID namestring Username created_utcnumber Account creation time in UTC epoch seconds link_karmanumber Total link karma comment_karmanumber Total comment karma total_karmanumber Combined total karma is_goldboolean Whether user has Reddit Premium is_modboolean Whether user is a moderator has_verified_emailboolean Whether email is verified icon_imgstring User avatar/icon URL
Get public profile information about any Reddit user by username
Parameter Type Required Description usernamestring Yes Reddit username to look up (e.g., "spez", "example_user")
Parameter Type Description idstring User ID namestring Username created_utcnumber Account creation time in UTC epoch seconds link_karmanumber Total link karma comment_karmanumber Total comment karma total_karmanumber Combined total karma is_goldboolean Whether user has Reddit Premium is_modboolean Whether user is a moderator has_verified_emailboolean Whether email is verified icon_imgstring User avatar/icon URL
Send a private message to a Reddit user
Parameter Type Required Description tostring Yes Recipient username (e.g., "example_user") or subreddit (e.g., "/r/subreddit") subjectstring Yes Message subject (max 100 characters) textstring Yes Message body in markdown format from_srstring No Subreddit name to send the message from (requires moderator mail permission)
Parameter Type Description successboolean Whether the message was sent successfully messagestring Success or error message
Retrieve private messages from your Reddit inbox
Parameter Type Required Description wherestring No Message folder to retrieve: "inbox" (all), "unread", "sent", "messages" (direct messages only), "comments" (comment replies), "selfreply" (self-post replies), or "mentions" (username mentions). Default: "inbox" limitnumber No Maximum number of messages to return (e.g., 25). Default: 25, max: 100 afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) markboolean No Whether to mark fetched messages as read countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all")
Parameter Type Description messagesarray Array of messages with sender, recipient, subject, body, and metadata ↳ id string Message ID ↳ name string Thing fullname (t4_xxxxx) ↳ author string Sender username ↳ dest string Recipient username ↳ subject string Message subject ↳ body string Message body text ↳ created_utc number Creation time in UTC epoch seconds ↳ new boolean Whether the message is unread ↳ was_comment boolean Whether the message is a comment reply ↳ context string Context URL for comment replies ↳ distinguished string Distinction: null/"moderator"/"admin" afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Get metadata and information about a subreddit
Parameter Type Required Description subredditstring Yes The subreddit to get info about (e.g., "technology", "programming", "news")
Parameter Type Description idstring Subreddit ID namestring Subreddit fullname (t5_xxxxx) display_namestring Subreddit name without prefix titlestring Subreddit title descriptionstring Full subreddit description (markdown) public_descriptionstring Short public description subscribersnumber Number of subscribers accounts_activenumber Number of currently active users created_utcnumber Creation time in UTC epoch seconds over18boolean Whether the subreddit is NSFW langstring Primary language of the subreddit subreddit_typestring Subreddit type: public, private, restricted, etc. urlstring Subreddit URL path (e.g., /r/technology/) icon_imgstring Subreddit icon URL banner_imgstring Subreddit banner URL
Get the rules and site-wide rules that apply to a subreddit
Parameter Type Required Description subredditstring Yes The subreddit to get rules for (e.g., "technology", "programming", "news")
Parameter Type Description rulesarray Array of subreddit-specific rules ↳ short_name string Short name/title of the rule ↳ description string Full description of the rule (markdown) ↳ description_html string HTML-rendered rule description ↳ violation_reason string Reason shown on the report menu when this rule is selected ↳ kind string What the rule applies to: "link", "comment", or "all" ↳ created_utc number Creation time in UTC epoch seconds ↳ priority number Display/order priority of the rule site_rulesarray Reddit site-wide rules that apply to the subreddit site_rules_flowarray Structured site-wide rules flow used by the report menu
Fetch submitted posts (t3) from a Reddit user profile
Parameter Type Required Description usernamestring Yes Reddit username whose posts to fetch (e.g., "spez", "example_user") sortstring No Sort method for posts: "hot", "new", "top", "controversial" (default: "new") timestring No Time filter for "top"/"controversial" sorts: "hour", "day", "week", "month", "year", or "all" (default: "all") limitnumber No Maximum number of posts to return (e.g., 25). Default: 25, max: 100 afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all") sr_detailboolean No Expand subreddit details in the response
Parameter Type Description postsarray Array of submitted posts with title, author, URL, score, and metadata ↳ id string Post ID ↳ name string Thing fullname (t3_xxxxx) ↳ title string Post title ↳ author string Author username ↳ url string Post URL ↳ permalink string Reddit permalink ↳ score number Post score (upvotes - downvotes) ↳ num_comments number Number of comments ↳ created_utc number Creation timestamp (UTC) ↳ is_self boolean Whether this is a text post ↳ selftext string Text content for self posts ↳ thumbnail string Thumbnail URL ↳ subreddit string Subreddit name afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Fetch comments (t1) made by a Reddit user
Parameter Type Required Description usernamestring Yes Reddit username whose comments to fetch (e.g., "spez", "example_user") sortstring No Sort method for comments: "hot", "new", "top", "controversial" (default: "new") timestring No Time filter for "top"/"controversial" sorts: "hour", "day", "week", "month", "year", or "all" (default: "all") limitnumber No Maximum number of comments to return (e.g., 25). Default: 25, max: 100 afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all") sr_detailboolean No Expand subreddit details in the response
Parameter Type Description commentsarray Array of comments with author, body, score, timestamp, and permalink ↳ id string Comment ID ↳ name string Thing fullname (t1_xxxxx) ↳ author string Comment author ↳ body string Comment text ↳ score number Comment score ↳ created_utc number Creation timestamp ↳ permalink string Comment permalink afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Fetch your own saved posts (t3) and comments (t1). You can only read your own saved items
Parameter Type Required Description usernamestring Yes Your own Reddit username (saved items can only be read for the authenticated user) limitnumber No Maximum number of items to return (e.g., 25). Default: 25, max: 100 afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all") sr_detailboolean No Expand subreddit details in the response
Parameter Type Description postsarray Array of saved posts (t3) with title, author, URL, score, and metadata ↳ id string Post ID ↳ name string Thing fullname (t3_xxxxx) ↳ title string Post title ↳ author string Author username ↳ url string Post URL ↳ permalink string Reddit permalink ↳ score number Post score (upvotes - downvotes) ↳ num_comments number Number of comments ↳ created_utc number Creation timestamp (UTC) ↳ is_self boolean Whether this is a text post ↳ selftext string Text content for self posts ↳ thumbnail string Thumbnail URL ↳ subreddit string Subreddit name commentsarray Array of saved comments (t1) with author, body, score, and permalink ↳ id string Comment ID ↳ name string Thing fullname (t1_xxxxx) ↳ author string Comment author ↳ body string Comment text ↳ score number Comment score ↳ created_utc number Creation timestamp ↳ permalink string Comment permalink afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Fetch information about one or more Reddit things (posts, comments, or subreddits) by their fullnames
Parameter Type Required Description idstring Yes Comma-separated list of thing fullnames to look up (e.g., "t3_abc123,t1_xyz789,t5_2qh33"). Prefixes: t1_ = comment, t3_ = post, t5_ = subreddit
Parameter Type Description postsarray Posts (t3) matched by the requested fullnames ↳ id string Post ID ↳ name string Thing fullname (t3_xxxxx) ↳ title string Post title ↳ author string Author username ↳ url string Post URL ↳ permalink string Reddit permalink ↳ score number Post score (upvotes - downvotes) ↳ num_comments number Number of comments ↳ created_utc number Creation timestamp (UTC) ↳ is_self boolean Whether this is a text post ↳ selftext string Text content for self posts ↳ thumbnail string Thumbnail URL ↳ subreddit string Subreddit name commentsarray Comments (t1) matched by the requested fullnames ↳ id string Comment ID ↳ name string Thing fullname (t1_xxxxx) ↳ author string Comment author ↳ body string Comment text ↳ score number Comment score ↳ created_utc number Creation timestamp ↳ permalink string Comment permalink subredditsarray Subreddits (t5) matched by the requested fullnames ↳ id string Subreddit ID ↳ name string Subreddit fullname (t5_xxxxx) ↳ display_name string Subreddit name without prefix ↳ title string Subreddit title ↳ public_description string Short public description ↳ subscribers number Number of subscribers ↳ over18 boolean Whether the subreddit is NSFW ↳ url string Subreddit URL path (e.g., /r/technology/) ↳ subreddit_type string Subreddit type: public, private, restricted, etc. ↳ icon_img string Subreddit icon URL ↳ created_utc number Creation time in UTC epoch seconds ↳ accounts_active number Number of currently active users
Search for subreddits by name and description
Parameter Type Required Description qstring Yes Search query to match against subreddit names and descriptions sortstring No Sort order for results: "relevance" or "activity". Default: "relevance" limitnumber No Maximum number of subreddits to return (e.g., 25). Default: 25, max: 100 afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) show_usersboolean No Whether to include matching user profiles in the results sr_detailboolean No Expand subreddit details in the response
Parameter Type Description subredditsarray Array of matching subreddits with name, description, and subscriber metadata ↳ id string Subreddit ID ↳ name string Subreddit fullname (t5_xxxxx) ↳ display_name string Subreddit name without prefix ↳ title string Subreddit title ↳ public_description string Short public description ↳ subscribers number Number of subscribers ↳ over18 boolean Whether the subreddit is NSFW ↳ url string Subreddit URL path (e.g., /r/technology/) ↳ subreddit_type string Subreddit type: public, private, restricted, etc. ↳ icon_img string Subreddit icon URL ↳ created_utc number Creation time in UTC epoch seconds ↳ accounts_active number Number of currently active users afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
List the subreddits the authenticated user is subscribed to
Parameter Type Required Description limitnumber No Maximum number of subreddits to return (e.g., 25). Default: 25, max: 100 afterstring No Fullname of a thing to fetch items after (for pagination) beforestring No Fullname of a thing to fetch items before (for pagination) countnumber No A count of items already seen in the listing (used for numbering) showstring No Show items that would normally be filtered (e.g., "all") sr_detailboolean No Expand subreddit details in the response
Parameter Type Description subredditsarray Array of subscribed subreddits with name, description, and subscriber metadata ↳ id string Subreddit ID ↳ name string Subreddit fullname (t5_xxxxx) ↳ display_name string Subreddit name without prefix ↳ title string Subreddit title ↳ public_description string Short public description ↳ subscribers number Number of subscribers ↳ over18 boolean Whether the subreddit is NSFW ↳ url string Subreddit URL path (e.g., /r/technology/) ↳ subreddit_type string Subreddit type: public, private, restricted, etc. ↳ icon_img string Subreddit icon URL ↳ created_utc number Creation time in UTC epoch seconds ↳ accounts_active number Number of currently active users afterstring Fullname of the last item for forward pagination beforestring Fullname of the first item for backward pagination
Report a Reddit post or comment to subreddit moderators for a rules violation
Parameter Type Required Description thing_idstring Yes Thing fullname to report (e.g., "t3_abc123" for post, "t1_def456" for comment) reasonstring No Reason for reporting (max 100 characters) other_reasonstring No Free-form custom reason for reporting (max 100 characters)
Parameter Type Description successboolean Whether the report was successful messagestring Success or error message
Hide one or more Reddit posts from your listings
Parameter Type Required Description idstring Yes Comma-separated list of post fullnames to hide (e.g., "t3_abc123,t3_def456")
Parameter Type Description successboolean Whether the hide was successful messagestring Success or error message
Unhide one or more previously hidden Reddit posts
Parameter Type Required Description idstring Yes Comma-separated list of post fullnames to unhide (e.g., "t3_abc123,t3_def456")
Parameter Type Description successboolean Whether the unhide was successful messagestring Success or error message
Mark a Reddit post as NSFW (not safe for work)
Parameter Type Required Description idstring Yes Post fullname to mark as NSFW (e.g., "t3_abc123")
Parameter Type Description successboolean Whether the operation was successful messagestring Success or error message
Remove the NSFW (not safe for work) mark from a Reddit post
Parameter Type Required Description idstring Yes Post fullname to unmark as NSFW (e.g., "t3_abc123")
Parameter Type Description successboolean Whether the operation was successful messagestring Success or error message
Mark one or more private messages as read
Parameter Type Required Description idstring Yes Comma-separated list of message fullnames to mark read (e.g., "t4_abc123,t4_def456")
Parameter Type Description successboolean Whether the operation was successful messagestring Success or error message
Mark all private messages in the inbox as read
Parameter Type Required Description
Parameter Type Description successboolean Whether the operation was successful messagestring Success or error message
Approve a reported or removed Reddit post or comment as a moderator
Parameter Type Required Description idstring Yes Thing fullname to approve (e.g., "t3_abc123" for post, "t1_def456" for comment)
Parameter Type Description successboolean Whether the approval was successful messagestring Success or error message
Remove a Reddit post or comment as a moderator, optionally marking it as spam
Parameter Type Required Description idstring Yes Thing fullname to remove (e.g., "t3_abc123" for post, "t1_def456" for comment) spamboolean No Mark the item as spam to train the subreddit spam filter (default: false)
Parameter Type Description successboolean Whether the removal was successful messagestring Success or error message
Distinguish or un-distinguish a Reddit post or comment as a moderator
Parameter Type Required Description idstring Yes Thing fullname to distinguish (e.g., "t3_abc123" for post, "t1_def456" for comment) howstring Yes Distinguish type: "yes" (moderator), "no" (remove distinction), "admin", or "special" stickyboolean No Sticky the comment to the top of the comment page (comments only)
Parameter Type Description successboolean Whether the distinguish action was successful messagestring Success or error message
Lock a Reddit post or comment to prevent further replies (moderator action)
Parameter Type Required Description idstring Yes Thing fullname to lock (e.g., "t3_abc123" for post, "t1_def456" for comment)
Parameter Type Description successboolean Whether the lock was successful messagestring Success or error message
Unlock a Reddit post or comment to allow replies again (moderator action)
Parameter Type Required Description idstring Yes Thing fullname to unlock (e.g., "t3_abc123" for post, "t1_def456" for comment)
Parameter Type Description successboolean Whether the unlock was successful messagestring Success or error message
Sticky or unsticky a Reddit post to the top of a subreddit (moderator action)
Parameter Type Required Description idstring Yes Post fullname to sticky/unsticky (e.g., "t3_abc123") stateboolean Yes true to sticky the post, false to unsticky it numnumber No Sticky slot to use, 1-4 (1 is the top slot). Only applies when stickying
Parameter Type Description successboolean Whether the sticky action was successful messagestring Success or error message
