Sign in
Chat Bots

Update a chat bot

Update an existing chat bot. Only provided fields are updated.

put/v1/chat-bots/{bot-name}

Path parameters

bot-namestring required

Chat bot name

Request body

descriptionstring

Chat bot description

driverNamestring

Chat bot driver name

configurationstring

Driver-specific configuration text

idleTimeoutinteger

Session idle timeout in seconds

providerSlotstring

AI provider slot for bot sessions (empty for default)

Response

Chat bot updated successfully

namestring

Chat bot name

descriptionstring

Chat bot description

driverNamestring

Chat bot driver name

configurationstring

Driver-specific configuration text

driverInitializedboolean

Whether the driver was initialized and started successfully

healthCheckStatusboolean

Health check status

idleTimeoutinteger

Session idle timeout in seconds

providerSlotstring

AI provider slot for bot sessions (empty for default)

activeSessionsinteger

Number of currently active chat sessions

lastInboundMessageTimestring

Timestamp of last inbound message

errorMessagestring

Last error message

Changes

Changed in 1 of the 71 revisions of this API.1