Skip to main content
PUT
Update
Every field is optional — send only the ones you want to change. The bot’s uid cannot be changed; delete the bot and create a new one instead. groupChatSetting accepts the same four values as the Create Bot API: allMessages, slashedMessages, mentionedMessages and none. Unlike the Create Bot API, Update stores username and password as sent, whatever useBasicAuth is set to. Setting useBasicAuth to false stops credentials being sent with webhook calls, but does not clear the stored username and password. They stay in responses. Setting enabled to false stops the bot relaying messages without deleting it. A bot’s name and avatar belong to its user — change them with the Update User API. updatedAt appears in the response once a bot has been updated.
The API returns the stored password value as it was saved, including after useBasicAuth is set to false. The example masks it as ********.
For the complete error reference, see Error Guide.

Authorizations

apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Path Parameters

uid
string
required

An UID of a bot.

Body

application/json
webhookURL
string

URL that receives the messages relayed to the bot. Maximum 255 characters.

groupChatSetting
enum<string>

Which group messages are relayed to the webhook. Possible values: allMessages, slashedMessages, mentionedMessages, none.

Available options:
allMessages,
slashedMessages,
mentionedMessages,
none
useBasicAuth
boolean

Sends HTTP basic auth credentials with every webhook call. Setting this to false does not clear a stored username or password.

username
string

Basic auth username. Maximum 50 characters. Stored as sent, whatever useBasicAuth is set to.

password
string

Basic auth password. Maximum 50 characters. Stored as sent, whatever useBasicAuth is set to, and returned in responses.

enabled
boolean

Whether the bot relays messages to its webhook.

Response

200 - application/json

Updated Bot

data
object