Set Rate Limit

Remove Rate Limit

This command (set_rate_limit) add a rate limit to the server. For more information on how rate limits work, consult the rate limit guide.

Permissions

User Permissions

  • The user's highest role must be higher in the role hierarchy than the bot's highest role.

Parameters

event_id

Required. The ID of the event to add. Must be a valid number. The list of valid IDs, along with their associated definitions, can be found in Discord's developer documentation (opens in a new tab).

limit

Required. The maximum number of events before the rate limit kicks in. This value will reset to 0 in our database after the amount of time specified by timeframe has passed. Must be between 0 and 1000, inclusive.

timeframe

Required. The interval in which to consider events. Specify this value in seconds. Must be between 60 and 10000000, inclusive.

action

Required. The action to take against members who exceed the rate limit. Must be one of warn, remove_roles, kick, and ban.

ephemeral

Optional. Whether other server members should be able to see the bot's response. Does not affect logging.

Cooldown

Like other commands, cooldowns operate at the server level. The cooldown values are:

BasicStandardAdvanced
2 hours1 hour5 minutes