RedRover Logo

Knowledge Base

Ban or Unban a Subreddit

Bans a subreddit so none of your content goes there, or lifts the ban.

PUT/subreddit-bans
Scope: knowledge:writeAI Connector Tool: redrover_set_subreddit_ban

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

  • X-Workspace-IdstringRequired

    The workspace to act on, from List Workspaces.

    UUID

Body

  • subredditstringRequired

    The subreddit, with or without r/. Letters, digits and underscores

    1 to 60 characters

  • bannedbooleanRequired

    true to ban, false to lift the ban

Response

200 The banned list after the change.

  • dataobjectRequired
    Show 1 Child Fields
    • bannedstring[]Required

      Subreddits your content must never go to, like r/example

Errors

Every error uses the error envelope.

  • 400subreddit is missing or invalid
  • 409The list can't be changed right now
  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl -X PUT "https://app.tryredrover.com/api/public/v1/subreddit-bans" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "X-Workspace-Id: $REDROVER_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "subreddit": "r/marketing",
  "banned": true
}'
200 Response
{
  "data": {
    "banned": [
      "r/Entrepreneur",
      "r/marketing"
    ]
  }
}