/ 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
- 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 bot

Updates information on a bot.

HTTP request

PUT https://api-{application_id}.sendbird.com/v3/bots/{bot_userid}

Parameters

The following table lists the parameters that this action supports.

Required

Parameter name	Type	Description
bot_userid	string	Specifies the unique ID of a bot.

Request body

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

Optional

Property name	Type	Description
bot_nickname	string	Specifies the bot's nickname. The length is limited to 80 characters.
bot_profile_url	string	Specifies the URL of the bot's profile image. The size is limited to 2,048 characters.
bot_callback_url	string	Specifies the server URL of where the bot is located to receive all events, requests, and data forwarded from an application. For security reasons, it is highly recommended that you use an SSL server. The length is limited to 1,024 characters.
is_privacy_mode	boolean	Determines whether to forward all or specific messages to the bot in channels where the bot is a member. If set to `true`, only messages starting with a "/" or mentioning the `bot_userid` are forwarded to the bot. If set to `false`, all messages are forwarded. This property can help protect the privacy of users' chat logs by configuring the bot to only receive messages addressed to the bot.
enable_mark_as_read	boolean	Determines whether to mark the bot's message as read upon sending it. (Default: `true`)
show_member	boolean	Determines whether to include information about the members of each channel in a callback response. (Default: `false`)
channel_invitation_preference	int	Determines whether the bot automatically joins the channel when invited or joins the channel after manually accepting an invitation using the API. If set to `0`, the bot automatically joins the channel. If set to `1`, the bot first has to respond to an invitation. (Default: `0`)

Response

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

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