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,
gpt-4o-mini,
o4-mini,
gpt-oss-120b,
gpt-oss-20b,
gpt-5,
gpt-5.1,
gpt-5.2,
gpt-5.4,
gpt-5.4-mini,
gpt-5.4-nano,
gpt-5-mini,
gpt-5-nano,
claude-opus-4-6,
claude-sonnet-4-6,
claude-opus-4-5,
claude-haiku-4-5,
claude-sonnet-4-5,
gemini-2.5-flash,
gemini-2.5-pro,
gemini-3-flash,
gemini-3.1-flash-lite,
gemini-3.1-pro,
grok-3,
grok-3-mini,
grok-4,
DeepSeek-V3,
DeepSeek-R1,
Llama-4-Scout-17B-16E-Instruct,
Llama-4-Maverick-17B-128E-Instruct-FP8,
kimi-k2
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."