PUT
/
v1
/
chatbot
/
{id}

Authorizations

x-api-key
string
headerrequired

Path Parameters

id
string
required

The chatbot's id.

Body

application/json
name
string

The chatbot's name.

welcomeMessage
string

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

resourceIds
string[]

An array of resource ids that the chatbot can use.

chatbotMessageColor
string

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

userMessageColor
string

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

accentColor
string

The HEX color of the chatbot's accent color. Will default to #000000.

conversationBackgroundColor
string

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

sideBarBackgroundColor
string

The HEX color of the chatbot's background color behind the conversation menu. Will default to #F2F2F2.

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'.

password
string

If the chatbot is private, the password to access it. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.

Response

200 - application/json
id
string
required

The chatbot's id.

name
string
required

The chatbot's name.

welcomeMessage
string
required

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

createdAt
number
required

The created date of the chatbot. Unix timestamp in milliseconds.

creator
string
required

The user id of the creator.

organisation
string
required

The organisation id of the chatbot.

resources
string[]
required

An array of resource ids that the chatbot can use.

chatbotMessageColor
string
required

The HEX background color of the chatbot's messages.

userMessageColor
string
required

The HEX background color of the user's messages.

accentColor
string
required

The HEX color of the chatbot's accent color.

conversationBackgroundColor
string
required

The HEX color of the chatbot's background color behind the messages of the selected conversation.

sideBarBackgroundColor
string
required

The HEX color of the chatbot's background color behind the conversation menu.

enabledEmoji
boolean
required

Whether or not the chatbot should use emojis.

model
string
required

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

accessLevel
string
required

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

customSystemPrompt
string

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

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.

websiteIntegration
object

The website integration configuration of the chatbot. Defined if the chatbot is set to be integrated on one or more websites.