Ban a user

POST {{baseUrl}}/v3/group_channels/:channel_url/ban

Ban a user

Bans a user from a group channel. A banned user is immediately expelled from a channel and allowed to join the channel again after a set time period.

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

Request Body

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

HEADERS

RESPONSES

status: OK

{"user":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_online":"\u003cboolean\u003e","user_id":"\u003cstring\u003e","access_token":"\u003cstring\u003e","has_ever_logged_in":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","nickname":"\u003cstring\u003e","discovery_keys":["\u003cstring\u003e","\u003cstring\u003e"],"session_tokens":["\u003cstring\u003e","\u003cstring\u003e"],"preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","created_at":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","local":"\u003cstring\u003e","locale":"\u003cstring\u003e","is_hide_me_from_friends":"\u003cboolean\u003e","is_shadow_blocked":"\u003cboolean\u003e","is_created":"\u003cboolean\u003e","metadata":{"constructor":{"arguments":{},"caller":{"value":"\u003cCircular reference to #/components/schemas/Function detected\u003e"},"length":"\u003cnumber\u003e","prototype":{}}},"description":"\u003cstring\u003e","end_at":"\u003cnumber\u003e","start_at":"\u003cnumber\u003e"},"start_at":"\u003cnumber\u003e","end_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"},"next_url":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","require_auth_for_profile_image":"\u003cboolean\u003e","user_id":"\u003cstring\u003e"}