v1

latestOpenAPI 3.0.32026-07-13170295.5 KB

Update Chatbot

patch/api/external/chatbots

Query parameters

idstring

Example:3317853e-0af2-427d-a56f-351a9587f48f

Headers

x-api-keystring

Example:15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68

Request body

descriptionstring

is_publicboolean

namestring

Example request

{
  "description": "A helpful support assistant",
  "name": "API Docs Demo Chatbot",
  "personality_config": {
    "style": "Friendly",
    "tone": "Professional"
  },
  "settings": {
    "greeting": "Hello! How can I assist you today?",
    "isToolEnabled": true,
    "model": "gpt-4o-mini",
    "prompt": "You are a highly skilled customer support assistant for [company name]. Your goal is to provide accurate, polite, and concise answers to customer inquiries. If you do not know the answer, recommend the customer to contact human support or check the FAQ section. Ensure a positive tone in all responses",
    "snippet": {
      "header": "Customer Support",
      "logo": "https://example.com/logo.png",
      "name": "Support Assistant",
      "primaryColor": "#4F46E5",
      "secondaryColor": "#10B981",
      "slogan": "How can I help you today?"
    }
  }
}

Response

Example

messagestring

Example response

{
  "chatbot": {
    "active": true,
    "created_at": "2025-01-22T04:30:45.790337+00:00",
    "description": "A helpful support assistant",
    "id": "3317853e-0af2-427d-a56f-351a9587f48f",
    "name": "API Docs Demo Chatbot",
    "organization_id": "123042b2-86e2-4184-a86e-95423d728815",
    "personality_config": {
      "style": "Friendly",
      "tone": "Professional"
    },
    "settings": {
      "greeting": "Hello! How can I assist you today?",
      "isToolEnabled": true,
      "model": "gpt-4o-mini",
      "prompt": "You are a highly skilled customer support assistant for [company name]. Your goal is to provide accurate, polite, and concise answers to customer inquiries. If you do not know the answer, recommend the customer to contact human support or check the FAQ section. Ensure a positive tone in all responses",
      "snippet": {
        "header": "Customer Support",
        "logo": "https://example.com/logo.png",
        "name": "Support Assistant",
        "primaryColor": "#4F46E5",
        "secondaryColor": "#10B981",
        "slogan": "How can I help you today?"
      }
    },
    "slug": "api-docs-demo-chatbot",
    "updated_at": "2025-01-22T04:30:45.790337+00:00"
  },
  "message": "Chatbot updated successfully"
}