/ 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
- 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
- - Managing a bot
  - Update a bot
  - Join channels
  - Leave channels
  - Delete a bot
- AI chatbot
- Overview
- - Managing AI chatbots
  - Create an AI chatbot
  - List AI chatbots
  - Get an AI chatbot
  - Update an AI chatbot
  - Delete an AI chatbot
- - Configuring content sources
  - Configure content sources
- 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 a feature

Turns on and off a feature for a specific application.

HTTP request

PATCH https://gate.sendbird.com/api/v2/applications/{app_id}/features

Parameters

The following table lists the parameters that this action supports.

Required

Parameter name	Type	Description
app_id	string	Specifies the unique ID of an application.

Request body

Optional

Property name	Type	Description
auto_thumbnail	boolean	Determines whether to turn on or off the thumbnail auto-generator feature. (Default: false)
translation_tools	boolean	Determines whether to turn on or off the message auto-translation feature. (Default: false)
image_moderation	boolean	Determines whether to turn on or off the image moderation feature. (Default: false)
data_export	boolean	Determines whether to turn on or off the data export feature.
domain_filter	boolean	Determines whether to turn on or off the domain filter feature. (Default: false)
profanity_filter	boolean	Determines whether to turn on or off the profanity filter feature. (Default: false)
delivery_receipt	boolean	Determines whether to turn on or off the delivery receipt feature.
announcement	boolean	Determines whether to turn on or off the announcements feature. (Default: false)
supergroup	boolean	Determines whether to turn on or off a Supergroup channel. (Default: false)
advanced_analytics	boolean	Determines whether to turn on or off the advanced analytics feature.
message_search	boolean	Determines whether to turn on or off the message search feature. (Default: false)

Request body example

{
    "auto_thumbnail": true,
    "domain_filter": true
}

Response

If successful, this action returns a feature resource in the response body.

Status: 200 OK

{
    "auto_thumbnail": true,
    "translation_tools": false,
    "image_moderation": false,
    "moderation_tools": false,
    "domain_filter": true,
    "profanity_filter": false,
    "data_export": true,
    "delivery_receipt": false,
    "announcement": false,
    "supergroup": false,
    "advanced_analytics": false,
    "message_search": false
}

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