Mute a user

POST {{baseUrl}}/v3/open_channels/:channel_url/mute

Mute a user

Mutes a user in the channel. A muted user remains in the channel and is allowed to view the messages, but can't send any messages until unmuted.

https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-mute-a-user

Request Body

{"user_id"=>"<string>", "seconds"=>"<integer>", "description"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;custom_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;cover_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;creator&quot;:{&quot;require_auth_for_profile_image&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_online&quot;:&quot;\u003cboolean\u003e&quot;,&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;access_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;has_ever_logged_in&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_seen_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;nickname&quot;:&quot;\u003cstring\u003e&quot;,&quot;discovery_keys&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;session_tokens&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;preferred_languages&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;profile_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;local&quot;:&quot;\u003cstring\u003e&quot;,&quot;locale&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_hide_me_from_friends&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_shadow_blocked&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_created&quot;:&quot;\u003cboolean\u003e&quot;,&quot;metadata&quot;:{&quot;constructor&quot;:{&quot;arguments&quot;:{},&quot;caller&quot;:{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Function detected\u003e&quot;},&quot;length&quot;:&quot;\u003cnumber\u003e&quot;,&quot;prototype&quot;:{}}},&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;end_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;start_at&quot;:&quot;\u003cnumber\u003e&quot;},&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_dynamic_partitioned&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_ephemeral&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_frozen&quot;:&quot;\u003cboolean\u003e&quot;,&quot;max_length_message&quot;:&quot;\u003cnumber\u003e&quot;,&quot;operators&quot;:[{&quot;require_auth_for_profile_image&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_online&quot;:&quot;\u003cboolean\u003e&quot;,&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;access_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;has_ever_logged_in&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_seen_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;nickname&quot;:&quot;\u003cstring\u003e&quot;,&quot;discovery_keys&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;session_tokens&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;preferred_languages&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;profile_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;local&quot;:&quot;\u003cstring\u003e&quot;,&quot;locale&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_hide_me_from_friends&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_shadow_blocked&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_created&quot;:&quot;\u003cboolean\u003e&quot;,&quot;metadata&quot;:{&quot;constructor&quot;:{&quot;arguments&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;caller&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;length&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;prototype&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;end_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;start_at&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;require_auth_for_profile_image&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_online&quot;:&quot;\u003cboolean\u003e&quot;,&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;access_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;has_ever_logged_in&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_seen_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;nickname&quot;:&quot;\u003cstring\u003e&quot;,&quot;discovery_keys&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;session_tokens&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;preferred_languages&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;profile_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;local&quot;:&quot;\u003cstring\u003e&quot;,&quot;locale&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_hide_me_from_friends&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_shadow_blocked&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_created&quot;:&quot;\u003cboolean\u003e&quot;,&quot;metadata&quot;:{&quot;constructor&quot;:{&quot;arguments&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;caller&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;length&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;prototype&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;end_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;start_at&quot;:&quot;\u003cnumber\u003e&quot;}],&quot;participant_count&quot;:&quot;\u003cnumber\u003e&quot;,&quot;freeze&quot;:&quot;\u003cboolean\u003e&quot;}