Skip to main content
POST
/
update-chatbot-settings
Update chatbot settings
curl --request POST \
  --url https://www.chatbase.co/api/v1/update-chatbot-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "chatbotId": "ckl123abc456",
  "name": "My Chatbot",
  "instructions": "You are a helpful customer service assistant",
  "initialMessages": [
    "Hello! How can I help you?"
  ],
  "suggestedMessages": [
    "What are your hours?",
    "How can I contact support?"
  ],
  "visibility": "public",
  "domains": [
    "example.com",
    "subdomain.example.com"
  ],
  "onlyAllowOnAddedDomains": false,
  "ipLimit": 10,
  "ipLimitTimeframe": 3600,
  "ipLimitMessage": "Too many requests. Please try again later.",
  "model": "gpt-4o-mini",
  "temp": 0.7,
  "styles": {
    "theme": "light",
    "buttonColor": "#007bff",
    "displayName": "Support Bot",
    "alignChatButton": "right",
    "userMessageColor": "#007bff",
    "autoOpenChatWindowAfter": 5
  },
  "collectCustomerInformation": {
    "title": "Contact Information",
    "name": {
      "active": true,
      "label": "Full Name"
    },
    "email": {
      "active": true,
      "label": "Email Address"
    },
    "phone": {
      "active": false,
      "label": "Phone Number"
    }
  }
}'
{
  "message": "Your changes are saved."
}

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:
["Hello! How can I help you?"]
​
suggestedMessages
string[]

Suggested conversation starters

Example:
[
  "What are your hours?",
  "How can I contact support?"
]
​
visibility
enum<string>

Chatbot visibility setting

Available options:
public,
private
Example:

"public"

​
domains
string[]

Allowed domains for the chatbot

Example:
["example.com", "subdomain.example.com"]
​
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-4-turbo,
gpt-4o,
gpt-4,
gpt-4o-mini,
gpt-4.1,
gpt-4.1-mini,
gpt-4.1-nano,
o3-mini,
o4-mini,
o3,
gpt-oss-120b,
gpt-oss-20b,
gpt-5,
gpt-5-mini,
gpt-5-nano,
claude-opus-4-1,
claude-sonnet-4,
claude-opus-4,
claude-3-7-sonnet,
claude-3-5-sonnet,
claude-3-haiku,
claude-3-opus,
gemini-1.5-flash,
gemini-1.5-pro,
gemini-2.0-flash,
gemini-2.0-pro,
gemini-2.5-flash,
grok-3,
grok-3-mini,
grok-4,
command-r,
command-r-plus,
command-a,
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."

⌘I