PATCH
/
api
/
external
/
chatbots
curl --request PATCH \
  --url https://v2.okchat.ai/api/external/chatbots \
  --header 'Content-Type: application/json' \
  --data '"{\n    \"name\": \"API Docs Demo Chatbot\",\n    \"description\": \"A helpful support assistant\",\n    \"personality_config\": {\n        \"tone\": \"Professional\",\n        \"style\": \"Friendly\"\n    },\n    \"settings\": {\n        \"model\": \"gpt-4o-mini\",\n        \"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\",\n        \"snippet\": {\n            \"logo\": \"https://example.com/logo.png\",\n            \"name\": \"Support Assistant\",\n            \"header\": \"Customer Support\",\n            \"slogan\": \"How can I help you today?\",\n            \"primaryColor\": \"#4F46E5\",\n            \"secondaryColor\": \"#10B981\"\n        },\n        \"greeting\": \"Hello! How can I assist you today?\",\n        \"isToolEnabled\": true,\n        \"isRequestUserInfoEnabled\": false // if enabled, chatbot will request the user'\''s email first\n    },\n    \"is_public\": false\n}"'
{
  "chatbot": {
    "active": true,
    "created_at": "2025-01-22T04:30:45.790337+00:00",
    "description": "A helpful support assistant",
    "docs_metadata": null,
    "enabled_plugins": null,
    "id": "3317853e-0af2-427d-a56f-351a9587f48f",
    "is_public": false,
    "managers": null,
    "migrated_data": false,
    "name": "API Docs Demo Chatbot",
    "openai_api_key": null,
    "organization_id": "123042b2-86e2-4184-a86e-95423d728815",
    "personality_config": {
      "style": "Friendly",
      "tone": "Professional"
    },
    "settings": {
      "greeting": "Hello! How can I assist you today?",
      "isRequestUserInfoEnabled": false,
      "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",
    "suggestions": null,
    "updated_at": "2025-01-22T04:30:45.790337+00:00",
    "v1_chatbot_id": null,
    "version_id": null,
    "voice_widget_config": null
  },
  "message": "Chatbot updated successfully"
}

Headers

x-api-key
string
Example:

"15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68"

Query Parameters

id
string
Example:

"3317853e-0af2-427d-a56f-351a9587f48f"

Body

application/json
description
string
Example:

"A helpful support assistant"

is_public
boolean
Example:

false

name
string
Example:

"API Docs Demo Chatbot"

personality_config
object
settings
object

Response

200 - application/json
Example
chatbot
object
message
string
Example:

"Chatbot updated successfully"