Update Chatbot By Id

put

https://api.droxy.ai/v1/chatbot/{id}

Update a chatbot by it's id.

Path Params

string

required

The chatbot's id.

Body Params

name

string

The chatbot's name.

welcomeMessage

string

The chatbot's welcome message. Displayed when the chatbot is first opened.

resourceIds

array of strings

An array of resource ids that the chatbot can use.

resourceIds

chatbotMessageColor

string

The HEX background color of the chatbot's messages. Will default to #F6F7F8.

userMessageColor

string

The HEX background color of the user's messages. Will default to #E0EEFA.

conversationBackgroundColor

string

The HEX color of the chatbot's background color behind the messages of the selected conversation. Will default to #FFFFFF.

secondaryBackgroundColor

string

The HEX color of the chatbot's secondary background color. Will default to #F6F7F8.

gradientColors

string

The HEX color of the chatbot's gradient color. Set to empty string to remove the gradient.

showBadge

boolean

Whether or not the chatbot should show the badge. Will default to false.

enabledEmoji

boolean

Whether or not the chatbot should use emojis.

customSystemPrompt

string

The custom system prompt the chatbot uses. This defines the behavior of the chatbot.

model

string

The model the chatbot uses. Values can be 'gpt-4o-mini' | 'gpt-4-turbo-preview' |'gpt-4'.

restrictAnswersToResourcesContentResponse

string

Answer the chatbot must return if information is not found in the resources. If not set, the chatbot will not be restricted to the knowledge from the resources.

accessLevel

string

The access level of the chatbot. Values can be 'PUBLIC' | 'PRIVATE' | 'PROTECTED'.

200OK

400Bad Request

401Unauthorized

403Forbidden

404Element not found

500Internal Server Error