/ Platform API

Platform API

Overview
Migrating to Sendbird
Prepare to use API
- User
- Overview
- - Listing users
  - List users
  - Get a user
- - Creating users
  - Create a user
- - Managing users
  - Update a user
  - Delete a user
- - Managing session tokens
  - Issue a session token
  - Revoke all session tokens
- - Managing joined group channels
  - List group channels by user
  - Leave group channels
- - Getting group channel count
  - Get number of channels by join status
- - Marking messages as read
  - Mark all of a user's messages as read
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Channel
- Overview
- - Listing channels in an application
  - List open channels
  - Get an open channel
  - List group channels
  - Get a group channel
- - Creating a channel
  - Create an open channel
  - Create a group channel
- - Inviting a user
  - Invite as members
  - Accept an invitation
  - Decline an invitation
- - Managing metacounter
  - Get metacounter
  - Create metacounter
  - Update metacounter
  - Delete metacounter
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- - Managing typing indicators
  - Start typing indicators
  - Stop typing indicators
- Application
- Overview
- - Setting up an application
  - Get global application settings
  - Update global application settings
- - Managing API tokens
  - List secondary API tokens
  - Get a secondary API token
  - Generate a secondary API token
  - Revoke a secondary API token
- - Managing IP whitelist
  - Get an IP whitelist
  - Add an IP to a whitelist
  - Delete IPs from a whitelist
- - Managing auto event messages
  - List auto event messages
  - Configure auto event message settings
- - Understanding rate limits
  - Rate limits
- - Getting failed webhooks
  - Get failed webhooks
- Organization
- Overview
- - Managing application
  - List applications
  - Get an application
  - Create an application
  - Delete an application
  - Copy application settings
- - Managing features
  - List features
  - Update a feature
- - Managing members
  - List members
  - Get a member
  - Update a member
  - Deactivate a member
- - Managing roles
  - List predefined roles
  - List custom roles
- - Managing audit logs
  - List audit logs
- Push notifications
- FCM migration guide
- Overview
- - Managing FCM configurations
  - Add an FCM push configuration
  - Update an FCM push configuration
- - Managing HMS configurations
  - Add an HMS push configuration
  - Update an HMS push configuration
- - Managing APNS configurations
  - Add an APNs push configuration
  - Update an APNs push configuration
  - Delete an APNs certificate
- Statistics
- Overview
- - Advanced analytics
  - Get advanced analytics metrics
- - Concurrent connections
  - Get number of concurrent connections
- - DAUs & MAUs
  - Get number of daily active users
  - Get number of monthly active users
- - Peak connections
  - Get number of peak connections
- Data export
- Overview
- - Listing data exports
  - List data exports by message, channel, or user
  - Get a data export
- - Scheduling data exports
  - Register and schedule a data export
- Bot
- Overview
- - Listing bots
  - List bots
  - Get a bot
- - Creating a bot
  - Create a bot
- - Sending a bot message
  - Send a bot message
  - Send a streaming message
- - Managing a bot
  - Update a bot
  - Join channels
  - Leave channels
  - Delete a bot
- Report
- Overview
- - Creating a report
  - Report a user
  - Report a channel
  - Report a message
- Webhook
- Overview
- - Managing subscribed events
  - Get a list of subscribed events
  - Choose events to subscribe
- Privacy
- Overview
- - Listing GDPR requests
  - List GDPR requests
  - Get a GDPR request
- - Creating a GDPR request
  - Register a GDPR request
- - Managing GDPR requests
  - Cancel the registration of a GDPR request
Deprecated
Error codes

Chat Platform API v3

Chat Platform API

Chat Platform API

Version 3

/

/

/

Update status of a banned participant of an open channel

Updates information about a banned participant of an open channel. You can adjust the duration of the ban or update the description about the ban with this API.

HTTP request

PUT https://api-{application_id}.sendbird.com/v3/open_channels/{channel_url}/ban/{banned_user_id}

Note: If you are using the in-app channel in Delight AI agent, the endpoint for your API request should start with https://api-{application_id}.svc.delight.ai/v3 instead of https://api-{application_id}.sendbird.com/v3. For more details, refer to our Delight AI agent guide.

Parameters

The following table lists the parameters that this action supports.

Required

Parameter name	Type	Description
channel_url	string	Specifies the URL of a channel.
banned_user_id	string	Specifies the unique ID of a banned user.

Request body

The following table lists the properties of an HTTP request that this action supports.

Properties

Required	Type	Description
seconds	int	Specifies the duration of ban in seconds. If set to -1, a user will be banned for ten years, which refers to a permanent ban on the Sendbird Dashboard. (Default: -1)

Optional	Type	Description
description	string	Specifies the reason for the ban. The maximum length is 250 characters.

Response

If successful, this action returns a banned user resource and updated ban information in the response body.

Status: 200 OK

{
    "user": {
        "user_id": "Matthew",
        "nickname": "Mooch",
        "profile_url": "https://sendbird.com/main/img/profiles/profile_47_512px.png",
        "metadata": {
            "font_preference": "times new roman",
            "font_color": "black"
        }
    },
    "start_at": 1543211469000,
    "end_at": 1543211529000,
    "description": "Too much talking"
}

List of response properties

Property name	Type	Description
user	object	The user resource that contains brief information about the banned user.
start_at	long	The time when the user becomes banned in the channel. The value is in Unix milliseconds format.
end_at	long	The timestamp of when the ban is scheduled to end. The value is in Unix milliseconds format.
description	string	The reason for the ban.

In the case of an error, an error object is returned. A detailed list of error codes is available here.

On this page

HTTP request Parameters Request body Response