SEsendbird
Bot

Update a bot

Changed on

Update a bot

Updates information on a bot.

https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-update-a-bot

put/v3/bots/{bot_userid}

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

bot_useridstring required

Headers

Api-Tokenstring

Request body

bot_useridstring required

Specifies the ID of the bot to update.

bot_nicknamestring required

Specifies the bot's nickname. The length is limited to 80 characters.

bot_profile_urlstring required

Specifies the URL of the bot's profile image. The size is limited to 2,048 characters.

bot_callback_urlstring required

Specifies the server URL where 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_modeboolean required

In the channels of where the bot is a member, determines whether to only forward the messages with the specific conditions to the bot or forword all messages to the bot, for privacy concerns. If set to true, only messages that start with a '/' or mention the bot_userid are forwarded to the bot. If set to false, all messages are forwarded.

enable_mark_as_readboolean required

Determines whether to mark the bot's message as read upon sending it. (Default: true)

show_memberboolean required

Determines whether to include information about the members of each channel in a callback response. (Default: false)

channel_invitation_preferenceinteger required

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, it automatically joins the channel. If set to 1, the latter takes place. (Default: 0)

Response

Successful response

bot_callback_urlstring
enable_mark_as_readboolean
is_privacy_modeboolean
show_memberboolean
channel_invitation_preferenceinteger

Example response

{
  "show_member": true,
  "enable_mark_as_read": true,
  "is_privacy_mode": true,
  "bot_callback_url": "bot_callback_url",
  "bot": {
    "bot_profile_url": "bot_profile_url",
    "bot_userid": "bot_userid",
    "bot_metadata": "{}",
    "bot_type": "bot_type",
    "bot_token": "bot_token",
    "bot_nickname": "bot_nickname"
  },
  "channel_invitation_preference": 0
}

Changes