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"
    }
  }
}
'
import requests

url = "https://www.chatbase.co/api/v1/update-chatbot-settings"

payload = {
"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"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
}
})
};

fetch('https://www.chatbase.co/api/v1/update-chatbot-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.chatbase.co/api/v1/update-chatbot-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://www.chatbase.co/api/v1/update-chatbot-settings"

payload := strings.NewReader("{\n \"chatbotId\": \"ckl123abc456\",\n \"name\": \"My Chatbot\",\n \"instructions\": \"You are a helpful customer service assistant\",\n \"initialMessages\": [\n \"Hello! How can I help you?\"\n ],\n \"suggestedMessages\": [\n \"What are your hours?\",\n \"How can I contact support?\"\n ],\n \"visibility\": \"public\",\n \"domains\": [\n \"example.com\",\n \"subdomain.example.com\"\n ],\n \"onlyAllowOnAddedDomains\": false,\n \"ipLimit\": 10,\n \"ipLimitTimeframe\": 3600,\n \"ipLimitMessage\": \"Too many requests. Please try again later.\",\n \"model\": \"gpt-4o-mini\",\n \"temp\": 0.7,\n \"styles\": {\n \"theme\": \"light\",\n \"buttonColor\": \"#007bff\",\n \"displayName\": \"Support Bot\",\n \"alignChatButton\": \"right\",\n \"userMessageColor\": \"#007bff\",\n \"autoOpenChatWindowAfter\": 5\n },\n \"collectCustomerInformation\": {\n \"title\": \"Contact Information\",\n \"name\": {\n \"active\": true,\n \"label\": \"Full Name\"\n },\n \"email\": {\n \"active\": true,\n \"label\": \"Email Address\"\n },\n \"phone\": {\n \"active\": false,\n \"label\": \"Phone Number\"\n }\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://www.chatbase.co/api/v1/update-chatbot-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chatbotId\": \"ckl123abc456\",\n \"name\": \"My Chatbot\",\n \"instructions\": \"You are a helpful customer service assistant\",\n \"initialMessages\": [\n \"Hello! How can I help you?\"\n ],\n \"suggestedMessages\": [\n \"What are your hours?\",\n \"How can I contact support?\"\n ],\n \"visibility\": \"public\",\n \"domains\": [\n \"example.com\",\n \"subdomain.example.com\"\n ],\n \"onlyAllowOnAddedDomains\": false,\n \"ipLimit\": 10,\n \"ipLimitTimeframe\": 3600,\n \"ipLimitMessage\": \"Too many requests. Please try again later.\",\n \"model\": \"gpt-4o-mini\",\n \"temp\": 0.7,\n \"styles\": {\n \"theme\": \"light\",\n \"buttonColor\": \"#007bff\",\n \"displayName\": \"Support Bot\",\n \"alignChatButton\": \"right\",\n \"userMessageColor\": \"#007bff\",\n \"autoOpenChatWindowAfter\": 5\n },\n \"collectCustomerInformation\": {\n \"title\": \"Contact Information\",\n \"name\": {\n \"active\": true,\n \"label\": \"Full Name\"\n },\n \"email\": {\n \"active\": true,\n \"label\": \"Email Address\"\n },\n \"phone\": {\n \"active\": false,\n \"label\": \"Phone Number\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://www.chatbase.co/api/v1/update-chatbot-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chatbotId\": \"ckl123abc456\",\n \"name\": \"My Chatbot\",\n \"instructions\": \"You are a helpful customer service assistant\",\n \"initialMessages\": [\n \"Hello! How can I help you?\"\n ],\n \"suggestedMessages\": [\n \"What are your hours?\",\n \"How can I contact support?\"\n ],\n \"visibility\": \"public\",\n \"domains\": [\n \"example.com\",\n \"subdomain.example.com\"\n ],\n \"onlyAllowOnAddedDomains\": false,\n \"ipLimit\": 10,\n \"ipLimitTimeframe\": 3600,\n \"ipLimitMessage\": \"Too many requests. Please try again later.\",\n \"model\": \"gpt-4o-mini\",\n \"temp\": 0.7,\n \"styles\": {\n \"theme\": \"light\",\n \"buttonColor\": \"#007bff\",\n \"displayName\": \"Support Bot\",\n \"alignChatButton\": \"right\",\n \"userMessageColor\": \"#007bff\",\n \"autoOpenChatWindowAfter\": 5\n },\n \"collectCustomerInformation\": {\n \"title\": \"Contact Information\",\n \"name\": {\n \"active\": true,\n \"label\": \"Full Name\"\n },\n \"email\": {\n \"active\": true,\n \"label\": \"Email Address\"\n },\n \"phone\": {\n \"active\": false,\n \"label\": \"Phone Number\"\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "message": "Your changes are saved."
}
{
"message": "Invalid request data"
}
{
"message": "No API key provided."
}
{
"message": "Access denied or quota exceeded"
}
{
"message": "Resource not found"
}
{
"message": "Internal server error"
}

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>

Enable or disable access to the chatbot

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