Sign in

v1

latestOpenAPI 3.0.32026-07-13201451.3 KB
Chatbots

Update chatbot settings

Updates various chatbot configuration settings

post/update-chatbot-settings

Request body

chatbotIdstring required

ID of the chatbot to update

namestring

Chatbot name

instructionsstring

System instructions for the chatbot

initialMessagesstring[]

Initial greeting messages

suggestedMessagesstring[]

Suggested conversation starters

visibility'public' | 'private'

Enable or disable access to the chatbot

domainsstring[]

Allowed domains for the chatbot

onlyAllowOnAddedDomainsboolean

Whether to restrict to allowed domains only

ipLimitinteger

Rate limit per IP address

ipLimitTimeframeinteger

Timeframe for IP rate limiting

ipLimitMessagestring

Message shown when rate limit is exceeded

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

AI model to use for the response

tempnumber

Temperature setting for AI responses

Example request

{
  "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"
  ],
  "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": {
      "label": "Phone Number"
    }
  }
}

Response

Settings updated successfully

messagestring

Example response

{
  "message": "Your changes are saved."
}