CHchatbase
Chatbots

Update chatbot settings

Changed on

Updates various chatbot configuration settings

post/update-chatbot-settings

Request

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-oss-120b' | 'gpt-oss-20b' | 'gpt-5.2' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-6-luna' | 'gpt-6.1-sol' | 'gpt-6.1-terra' | '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'

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-6-luna",
  "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."
}

Changes

  • 31f28120b5c9Revision changes
    • breaking

      removed the enum value gpt-4o-mini of the request property

    • info

      added the new gpt-6.1-terra enum value to the request property

  • 28d9cd7e1343Revision changes
    • breaking

      removed the enum value DeepSeek-V3 of the request property

    • breaking

      removed the enum value Llama-4-Maverick-17B-128E-Instruct-FP8 of the request property

    • breaking

      removed the enum value Llama-4-Scout-17B-16E-Instruct of the request property

    • breaking

      removed the enum value claude-haiku-4-5 of the request property

    • breaking

      removed the enum value claude-opus-4-5 of the request property

    • breaking

      removed the enum value claude-opus-4-6 of the request property

    • breaking

      removed the enum value claude-opus-4-7 of the request property

    • breaking

      removed the enum value claude-opus-4-8 of the request property

    • breaking

      removed the enum value claude-sonnet-4-5 of the request property

    • breaking

      removed the enum value claude-sonnet-4-6 of the request property

    • breaking

      removed the enum value gemini-3.5-flash of the request property

    • breaking

      removed the enum value gpt-5-mini of the request property

    • breaking

      removed the enum value gpt-5-nano of the request property

    • breaking

      removed the enum value gpt-5.6-luna of the request property

    • breaking

      removed the enum value grok-3 of the request property

    • breaking

      removed the enum value grok-3-mini of the request property

    • breaking

      removed the enum value grok-4 of the request property

    • breaking

      removed the enum value kimi-k2 of the request property

    • info

      added the new DeepSeek-V3.1 enum value to the request property

    • info

      added the new DeepSeek-V4.1-Flash enum value to the request property

    • info

      added the new claude-haiku-5-5 enum value to the request property

    • info

      added the new claude-opus-5-5 enum value to the request property

    • info

      added the new claude-sonnet-5-5 enum value to the request property

    • info

      added the new gemini-3.8-flash enum value to the request property

    • info

      added the new glm-5.3-flash enum value to the request property

    • info

      added the new gpt-6-luna enum value to the request property

    • info

      added the new gpt-6.1-sol enum value to the request property

    • info

      added the new grok-4.7 enum value to the request property

    • info

      added the new kimi-k2.6 enum value to the request property