Chatbots

Update Chatbot

Change a chatbot's settings. Only the fields you send are changed; everything else keeps its current value. Returns the chatbot with its current settings.

NOTE: Read the current values with chatbots.get first. specific_instructions and quick_buttons replace the whole list, so send the full list back with your change. custom_instructions is free-form guidance for the AI; specific_instructions are short rules (mark is_critical=true for rules the bot must never break); tone_of_voice is a free-text description of the voice that refines ai_tone. Visual styling, the AI model, live-chat routing and integrations cannot be changed here.

put/chatbots/{chatbot_id}

Request

Base URL
https://app.boei.help/api/v1
Auth
HTTP bearer

Request body

namestring

Chatbot display name.

business_namestring

Your business name as the bot introduces it.

business_descriptionstring

What the business does, used to ground answers.

opening_textstring

First message the visitor sees.

placeholder_textstring

Placeholder in the chat input.

button_textstring

Label on the chat button.

custom_instructionsstring

Free-form instructions for the AI.

quick_prompts_displaystring

When to show the quick prompts: always, once (only at the start of a conversation) or never.

ai_tonestring

One of: appreciative, assertive, authoritative, conciliatory, curious, empathetic, energetic, friendly, humorous, informative, inspirational, objective, persuasive, professional, supportive, thoughtful, urgent.

tone_of_voicestring

Extra description of the voice (max 400 chars).

ai_response_lengthstring

One of: short, medium, long.

ai_follow_up_questionsboolean

Suggest follow-up questions after answers.

focusstring

informational or conversion.

primary_goalstring

What the bot should steer visitors towards.

languagestring

Default language code.

respond_in_user_languageboolean

Answer in the visitor's language.

web_search_enabledboolean

Allow the bot to search the web when training data has no answer.

show_sourcesboolean

Show source links under answers.

allowed_sensitive_topicsstring[]

Topics the bot may discuss: politics, religion, legal_advice, medical_advice, competitor_comparison.

custom_blocked_topicsstring[]

Topics the bot must refuse (max 20).

Example request

{
  "name": "Support Bot",
  "business_name": "Acme Inc",
  "business_description": "We sell and install solar panels in the Netherlands.",
  "opening_text": "Hi! Ask me anything about our solar panels.",
  "placeholder_text": "Type your question...",
  "button_text": "Chat with us",
  "custom_instructions": "Always mention our 10-year warranty when discussing panels.",
  "specific_instructions": [
    {
      "text": "Never quote prices, refer to the sales team.",
      "is_critical": true
    }
  ],
  "quick_buttons": [
    {
      "text": "Opening hours"
    },
    {
      "text": "Request a quote"
    }
  ],
  "quick_prompts_display": "always",
  "ai_tone": "friendly",
  "tone_of_voice": "Warm, concise, no jargon.",
  "ai_response_length": "short",
  "ai_follow_up_questions": true,
  "focus": "conversion",
  "primary_goal": "Book a free roof scan",
  "language": "nl",
  "respond_in_user_language": true,
  "show_sources": true,
  "allowed_sensitive_topics": [
    "competitor_comparison"
  ],
  "custom_blocked_topics": [
    "salary",
    "lawsuit"
  ]
}

Response

chatbot_idstring

namestring

statusstring

training_sourcesinteger

created_atstring

Example response

{
  "chatbot_id": "8a832d1b-0f49-47f6-a05f-0b65b91d2107",
  "name": "Support Bot",
  "status": "ready",
  "training_sources": 12,
  "created_at": "2026-01-15T08:00:00+00:00",
  "settings": {
    "business_name": "Acme Inc",
    "opening_text": "Hi! Ask me anything about our solar panels.",
    "ai_tone": "friendly",
    "specific_instructions": [
      {
        "text": "Never quote prices, refer to the sales team.",
        "is_critical": true
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.