---
title: "Mute user"
method: POST
path: "/moderation/mute"
tags: ["Users", "Moderation"]
---

# Mute user

`POST /moderation/mute`

Mutes one or several users

## Request body

- MuteUserRequest, nullable
  - `target_ids` string[], required — User IDs to mute (if multiple users)
  - `timeout` number — Duration of mute in minutes
  - `user` UserObjectRequest — Represents chat user
    - `ban_expires` string, date-time — Expiration date of the ban
    - `banned` boolean — Whether a user is banned or not
    - `id` string, required — Unique user identifier
    - `invisible` boolean
    - `language` string — Preferred language of a user
    - `push_notifications` PushNotificationSettingsRequest
      - `disabled` boolean
      - `disabled_until` string, date-time
    - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
    - `role` string — Determines the set of user permissions
    - `teams` string[] — List of teams user is a part of
  - `user_id` string

## Response `201`

Successful response

- MuteUserResponse, nullable
  - `duration` string, required
  - `mute` UserMute, nullable
    - `created_at` string, date-time, required — Date/time of creation
    - `expires` string, date-time — Date/time of mute expiration
    - `target` UserObject — Represents chat user
      - `ban_expires` string, date-time — Expiration date of the ban
      - `banned` boolean, required — Whether a user is banned or not
      - `created_at` string, date-time — Date/time of creation
      - `deactivated_at` string, date-time — Date of deactivation
      - `deleted_at` string, date-time — Date/time of deletion
      - `id` string, required — Unique user identifier
      - `invisible` boolean
      - `language` string — Preferred language of a user
      - `last_active` string, date-time — Date of last activity
      - `online` boolean, required — Whether a user online or not
      - `push_notifications` PushNotificationSettings
        - `disabled` boolean
        - `disabled_until` string, date-time
      - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
      - `role` string, required — Determines the set of user permissions
      - `teams` string[] — List of teams user is a part of
      - `updated_at` string, date-time — Date/time of the last update
    - `updated_at` string, date-time, required — Date/time of the last update
    - `user` UserObject — Represents chat user
      - `ban_expires` string, date-time — Expiration date of the ban
      - `banned` boolean, required — Whether a user is banned or not
      - `created_at` string, date-time — Date/time of creation
      - `deactivated_at` string, date-time — Date of deactivation
      - `deleted_at` string, date-time — Date/time of deletion
      - `id` string, required — Unique user identifier
      - `invisible` boolean
      - `language` string — Preferred language of a user
      - `last_active` string, date-time — Date of last activity
      - `online` boolean, required — Whether a user online or not
      - `push_notifications` PushNotificationSettings
        - `disabled` boolean
        - `disabled_until` string, date-time
      - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
      - `role` string, required — Determines the set of user permissions
      - `teams` string[] — List of teams user is a part of
      - `updated_at` string, date-time — Date/time of the last update
  - `mutes` UserMute[] — Object with mutes (if multiple users were muted)
    - `created_at` string, date-time, required — Date/time of creation
    - `expires` string, date-time — Date/time of mute expiration
    - `target` UserObject — Represents chat user
      - `ban_expires` string, date-time — Expiration date of the ban
      - `banned` boolean, required — Whether a user is banned or not
      - `created_at` string, date-time — Date/time of creation
      - `deactivated_at` string, date-time — Date of deactivation
      - `deleted_at` string, date-time — Date/time of deletion
      - `id` string, required — Unique user identifier
      - `invisible` boolean
      - `language` string — Preferred language of a user
      - `last_active` string, date-time — Date of last activity
      - `online` boolean, required — Whether a user online or not
      - `push_notifications` PushNotificationSettings
        - `disabled` boolean
        - `disabled_until` string, date-time
      - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
      - `role` string, required — Determines the set of user permissions
      - `teams` string[] — List of teams user is a part of
      - `updated_at` string, date-time — Date/time of the last update
    - `updated_at` string, date-time, required — Date/time of the last update
    - `user` UserObject — Represents chat user
      - `ban_expires` string, date-time — Expiration date of the ban
      - `banned` boolean, required — Whether a user is banned or not
      - `created_at` string, date-time — Date/time of creation
      - `deactivated_at` string, date-time — Date of deactivation
      - `deleted_at` string, date-time — Date/time of deletion
      - `id` string, required — Unique user identifier
      - `invisible` boolean
      - `language` string — Preferred language of a user
      - `last_active` string, date-time — Date of last activity
      - `online` boolean, required — Whether a user online or not
      - `push_notifications` PushNotificationSettings
        - `disabled` boolean
        - `disabled_until` string, date-time
      - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
      - `role` string, required — Determines the set of user permissions
      - `teams` string[] — List of teams user is a part of
      - `updated_at` string, date-time — Date/time of the last update
  - `own_user` OwnUser
    - `banned` boolean, required
    - `channel_mutes` ChannelMute[], required
      - `channel` ChannelResponse — Represents channel in chat
        - `auto_translation_enabled` boolean — Whether auto translation is enabled or not
        - `auto_translation_language` string — Language to translate to when auto translation is active
        - `cid` string, required — Channel CID (<type>:<id>)
        - `config` ChannelConfigWithInfo
          - `automod` 'disabled' | 'simple' | 'AI', required
          - `automod_behavior` 'flag' | 'block', required
          - `automod_thresholds` Thresholds — Sets thresholds for AI moderation
            - `explicit` LabelThresholds
              - …
            - `spam` LabelThresholds
              - …
            - `toxic` LabelThresholds
              - …
          - `blocklist` string
          - `blocklist_behavior` 'flag' | 'block'
          - `commands` Command[], required
            - `args` string, required — Arguments help text, shown in commands auto-completion
            - `created_at` string, date-time — Date/time of creation
            - `description` string, required — Description, shown in commands auto-completion
            - `name` string, required — Unique command name
            - `set` string, required — Set name used for grouping commands
            - `updated_at` string, date-time — Date/time of the last update
          - `connect_events` boolean, required
          - `created_at` string, date-time, required
          - `custom_events` boolean, required
          - `grants` object
          - `max_message_length` number, required
          - `message_retention` string, required
          - `mutes` boolean, required
          - `name` string, required
          - `push_notifications` boolean, required
          - `quotes` boolean, required
          - `reactions` boolean, required
          - `read_events` boolean, required
          - `reminders` boolean, required
          - `replies` boolean, required
          - `search` boolean, required
          - `typing_events` boolean, required
          - `updated_at` string, date-time, required
          - `uploads` boolean, required
          - `url_enrichment` boolean, required
        - `cooldown` number — Cooldown period after sending each message
        - `created_at` string, date-time — Date/time of creation
        - `created_by` UserObject — Represents chat user
          - `ban_expires` string, date-time — Expiration date of the ban
          - `banned` boolean, required — Whether a user is banned or not
          - `created_at` string, date-time — Date/time of creation
          - `deactivated_at` string, date-time — Date of deactivation
          - `deleted_at` string, date-time — Date/time of deletion
          - `id` string, required — Unique user identifier
          - `invisible` boolean
          - `language` string — Preferred language of a user
          - `last_active` string, date-time — Date of last activity
          - `online` boolean, required — Whether a user online or not
          - `push_notifications` PushNotificationSettings
            - `disabled` boolean
            - `disabled_until` string, date-time
          - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
          - `role` string, required — Determines the set of user permissions
          - `teams` string[] — List of teams user is a part of
          - `updated_at` string, date-time — Date/time of the last update
        - `deleted_at` string, date-time — Date/time of deletion
        - `disabled` boolean, required
        - `frozen` boolean, required — Whether channel is frozen or not
        - `hidden` boolean — Whether this channel is hidden by current user or not
        - `hide_messages_before` string, date-time — Date since when the message history is accessible
        - `id` string, required — Channel unique ID
        - `last_message_at` string, date-time — Date of the last message sent
        - `member_count` number — Number of members in the channel
        - `members` ChannelMember[] — List of channel members (max 100)
          - `ban_expires` string, date-time — Expiration date of the ban
          - `banned` boolean, required — Whether member is banned this channel or not
          - `channel_role` string, required — Role of the member in the channel
          - `created_at` string, date-time, required — Date/time of creation
          - `deleted_at` string, date-time
          - `invite_accepted_at` string, date-time — Date when invite was accepted
          - `invite_rejected_at` string, date-time — Date when invite was rejected
          - `invited` boolean — Whether member was invited or not
          - `is_moderator` boolean — Whether member is channel moderator or not
          - `role` 'member' | 'moderator' | 'admin' | 'owner' — Permission level of the member in the channel (DEPRECATED: use channel_role instead)
          - `shadow_banned` boolean, required — Whether member is shadow banned in this channel or not
          - `updated_at` string, date-time, required — Date/time of the last update
          - `user` UserObject — Represents chat user
            - `ban_expires` string, date-time — Expiration date of the ban
            - `banned` boolean, required — Whether a user is banned or not
            - `created_at` string, date-time — Date/time of creation
            - `deactivated_at` string, date-time — Date of deactivation
            - `deleted_at` string, date-time — Date/time of deletion
            - `id` string, required — Unique user identifier
            - `invisible` boolean
            - `language` string — Preferred language of a user
            - `last_active` string, date-time — Date of last activity
            - `online` boolean, required — Whether a user online or not
            - `push_notifications` PushNotificationSettings
              - …
            - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
            - `role` string, required — Determines the set of user permissions
            - `teams` string[] — List of teams user is a part of
            - `updated_at` string, date-time — Date/time of the last update
          - `user_id` string
        - `mute_expires_at` string, date-time — Date of mute expiration
        - `muted` boolean — Whether this channel is muted or not
        - `own_capabilities` string[] — List of channel capabilities of authenticated user
        - `team` string — Team the channel belongs to (multi-tenant only)
        - `truncated_at` string, date-time — Date of the latest truncation of the channel
        - `truncated_by` UserObject — Represents chat user
          - `ban_expires` string, date-time — Expiration date of the ban
          - `banned` boolean, required — Whether a user is banned or not
          - `created_at` string, date-time — Date/time of creation
          - `deactivated_at` string, date-time — Date of deactivation
          - `deleted_at` string, date-time — Date/time of deletion
          - `id` string, required — Unique user identifier
          - `invisible` boolean
          - `language` string — Preferred language of a user
          - `last_active` string, date-time — Date of last activity
          - `online` boolean, required — Whether a user online or not
          - `push_notifications` PushNotificationSettings
            - `disabled` boolean
            - `disabled_until` string, date-time
          - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
          - `role` string, required — Determines the set of user permissions
          - `teams` string[] — List of teams user is a part of
          - `updated_at` string, date-time — Date/time of the last update
        - `type` string, required — Type of the channel
        - `updated_at` string, date-time — Date/time of the last update
      - `created_at` string, date-time, required — Date/time of creation
      - `expires` string, date-time — Date/time of mute expiration
      - `updated_at` string, date-time, required — Date/time of the last update
      - `user` UserObject — Represents chat user
        - `ban_expires` string, date-time — Expiration date of the ban
        - `banned` boolean, required — Whether a user is banned or not
        - `created_at` string, date-time — Date/time of creation
        - `deactivated_at` string, date-time — Date of deactivation
        - `deleted_at` string, date-time — Date/time of deletion
        - `id` string, required — Unique user identifier
        - `invisible` boolean
        - `language` string — Preferred language of a user
        - `last_active` string, date-time — Date of last activity
        - `online` boolean, required — Whether a user online or not
        - `push_notifications` PushNotificationSettings
          - `disabled` boolean
          - `disabled_until` string, date-time
        - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
        - `role` string, required — Determines the set of user permissions
        - `teams` string[] — List of teams user is a part of
        - `updated_at` string, date-time — Date/time of the last update
    - `created_at` string, date-time, required
    - `deactivated_at` string, date-time
    - `deleted_at` string, date-time
    - `devices` Device[], required
      - `created_at` string, date-time, required — Date/time of creation
      - `disabled` boolean — Whether device is disabled or not
      - `disabled_reason` string — Reason explaining why device had been disabled
      - `id` string, required
      - `push_provider` string, required
      - `push_provider_name` string
      - `user_id` string, required
    - `id` string, required
    - `invisible` boolean
    - `language` string, required
    - `last_active` string, date-time
    - `latest_hidden_channels` string[]
    - `mutes` UserMute[], required
      - `created_at` string, date-time, required — Date/time of creation
      - `expires` string, date-time — Date/time of mute expiration
      - `target` UserObject — Represents chat user
        - `ban_expires` string, date-time — Expiration date of the ban
        - `banned` boolean, required — Whether a user is banned or not
        - `created_at` string, date-time — Date/time of creation
        - `deactivated_at` string, date-time — Date of deactivation
        - `deleted_at` string, date-time — Date/time of deletion
        - `id` string, required — Unique user identifier
        - `invisible` boolean
        - `language` string — Preferred language of a user
        - `last_active` string, date-time — Date of last activity
        - `online` boolean, required — Whether a user online or not
        - `push_notifications` PushNotificationSettings
          - `disabled` boolean
          - `disabled_until` string, date-time
        - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
        - `role` string, required — Determines the set of user permissions
        - `teams` string[] — List of teams user is a part of
        - `updated_at` string, date-time — Date/time of the last update
      - `updated_at` string, date-time, required — Date/time of the last update
      - `user` UserObject — Represents chat user
        - `ban_expires` string, date-time — Expiration date of the ban
        - `banned` boolean, required — Whether a user is banned or not
        - `created_at` string, date-time — Date/time of creation
        - `deactivated_at` string, date-time — Date of deactivation
        - `deleted_at` string, date-time — Date/time of deletion
        - `id` string, required — Unique user identifier
        - `invisible` boolean
        - `language` string — Preferred language of a user
        - `last_active` string, date-time — Date of last activity
        - `online` boolean, required — Whether a user online or not
        - `push_notifications` PushNotificationSettings
          - `disabled` boolean
          - `disabled_until` string, date-time
        - `revoke_tokens_issued_before` string, date-time — Revocation date for tokens
        - `role` string, required — Determines the set of user permissions
        - `teams` string[] — List of teams user is a part of
        - `updated_at` string, date-time — Date/time of the last update
    - `online` boolean, required
    - `push_notifications` PushNotificationSettings
      - `disabled` boolean
      - `disabled_until` string, date-time
    - `role` string, required
    - `teams` string[]
    - `total_unread_count` number, required
    - `unread_channels` number, required
    - `unread_count` number, required
    - `updated_at` string, date-time, required

## Other responses

- `400` — Bad request
- `429` — Too many requests

---

[API](https://skmtc.net/streamioapi/apis/stream-io-api.md) · [All operations](https://skmtc.net/streamioapi/apis/stream-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/streamioapi/stream-io-api/versions/f5553620777b/schema)