Skip to main content
POST
Update chatbot settings

Authorizations

Authorization
string
header
required

API key in Bearer token format

Body

application/json
chatbotId
string
required

ID of the chatbot to update

Example:

"ckl123abc456"

name
string

Chatbot name

Example:

"My Chatbot"

instructions
string

System instructions for the chatbot

Example:

"You are a helpful customer service assistant"

initialMessages
string[]

Initial greeting messages

Example:
suggestedMessages
string[]

Suggested conversation starters

Example:
visibility
enum<string>

Enable or disable access to the chatbot

Available options:
public,
private
Example:

"public"

domains
string[]

Allowed domains for the chatbot

Example:
onlyAllowOnAddedDomains
boolean

Whether to restrict to allowed domains only

Example:

false

ipLimit
integer

Rate limit per IP address

Example:

10

ipLimitTimeframe
integer

Timeframe for IP rate limiting

Example:

3600

ipLimitMessage
string

Message shown when rate limit is exceeded

Example:

"Too many requests. Please try again later."

model
enum<string>

AI model to use for the response

Available options:
gpt-4o-mini,
gpt-oss-120b,
gpt-oss-20b,
gpt-5.2,
gpt-5.5,
gpt-5.6-terra,
gpt-6-luna,
gpt-6.1-sol,
claude-opus-5-5,
claude-sonnet-5-5,
claude-haiku-5-5,
gemini-2.5-pro,
gemini-3-flash,
gemini-3.1-flash-lite,
gemini-3.1-pro,
gemini-3.5-flash-lite,
gemini-3.6-flash,
gemini-3.8-flash,
grok-4.7,
DeepSeek-V3.1,
DeepSeek-R1,
DeepSeek-V4-Flash,
DeepSeek-V4.1-Flash,
kimi-k2.6,
mistral-medium-3.5,
mistral-small-2603,
glm-5.2,
glm-5.3-flash,
auto
Example:

"gpt-4o-mini"

temp
number

Temperature setting for AI responses

Required range: 0 <= x <= 1
Example:

0.7

styles
object
collectCustomerInformation
object

Response

Settings updated successfully

message
string
Example:

"Your changes are saved."