Sign in

v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-07186533829.2 KB
product:chat

Ban user

Restricts user activity either in specific channel or globally

Sends events:

  • user.banned
  • user.messages.deleted
post/moderation/ban

Request body

ban_from_future_channelsboolean

Whether to also ban the user from all future channels created by the banner

banned_by_idstring

User ID who issued a ban

channel_cidstring

Channel CID to ban user in eg. messaging:123

delete_messages'soft' | 'pruning' | 'hard'
delete_reactionsboolean

Whether to delete reactions by the banned user on other users' messages

ip_banboolean

Whether to perform IP ban or not

reasonstring

Ban reason

shadowboolean

Whether to perform shadow ban or not

target_user_idstring required

ID of user to ban

timeoutinteger

Timeout of ban in minutes. User will be unbanned after this period of time

user_idstring

Response

Response

durationstring required

Duration of the request in milliseconds