> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleartalk.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a chatbot



## OpenAPI

````yaml patch /chatbot/{id}
openapi: 3.0.0
info:
  title: ClearTalk API
  description: The ClearTalk API Documentation
  version: '1.0'
  contact:
    name: Developer Support
    email: devsupport@cleartalk.ai
servers:
  - url: https://api.cleartalk.ai
    description: ClearTalk AI API Server
security: []
tags: []
paths:
  /chatbot/{id}:
    patch:
      tags:
        - chatbot
      summary: Update a chatbot
      operationId: ChatbotController_update
      parameters:
        - name: id
          required: true
          in: path
          description: Chatbot ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                chatbot_image:
                  type: string
                  format: binary
                bubbleIconImage:
                  type: string
                  format: binary
                chatbotName:
                  type: string
                chatbot_title:
                  type: string
                header_color:
                  type: string
                background_color:
                  type: string
                text_color:
                  type: string
                pathway_id:
                  type: string
                welcome_message:
                  type: string
                template:
                  type: string
                  enum:
                    - classic
                    - modern
                    - glassmorphism
                bubble_icon:
                  type: string
                  enum:
                    - message-circle
                    - sparkles
                    - bot
                    - headphones
                    - help-circle
                    - heart
                bubble_position:
                  type: string
                  enum:
                    - bottom-right
                    - bottom-left
                    - bottom-center
                bubble_size:
                  type: string
                  enum:
                    - small
                    - medium
                    - large
                auto_open:
                  type: boolean
                user_message_color:
                  type: string
                input_placeholder:
                  type: string
                greeting_text:
                  type: string
                show_branding:
                  type: boolean
                input_bg_color:
                  type: string
      responses:
        '200':
          description: Chatbot updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChatbotDto'
      security:
        - apiKey: []
components:
  schemas:
    UpdateChatbotDto:
      type: object
      properties:
        chatbotName:
          type: string
          description: Name of the chatbot
        chatbot_title:
          type: string
          description: Title of the chatbot
        header_color:
          type: string
          description: Header color in hex format
          example: '#000000'
        background_color:
          type: string
          description: Background color in hex format
          example: '#FFFFFF'
        text_color:
          type: string
          description: Text color in hex format
          example: '#000000'
        chatbot_image:
          type: string
          description: Path to chatbot image
        pathway_id:
          type: string
          description: Pathway ID
        welcome_message:
          type: string
          description: Welcome message shown when chat starts
          example: Hi! How can I help you today?
        webhook_url:
          type: string
          description: >-
            Webhook URL to receive extracted variables when a conversation
            completes
          example: https://example.com/webhook
        template:
          type: string
          description: UI template for the chatbot widget
          example: modern
          enum:
            - classic
            - modern
            - glassmorphism
        bubble_icon:
          type: string
          description: Icon for the chat bubble
          example: message-circle
          enum:
            - message-circle
            - sparkles
            - bot
            - headphones
            - help-circle
            - heart
        bubble_position:
          type: string
          description: Position of the chat bubble
          example: bottom-right
          enum:
            - bottom-right
            - bottom-left
            - bottom-center
        bubble_size:
          type: string
          description: Size of the chat bubble
          example: medium
          enum:
            - small
            - medium
            - large
        auto_open:
          type: boolean
          description: Whether the chat window opens automatically
          example: false
        user_message_color:
          type: string
          description: Color for user message bubbles (hex)
          example: '#007bff'
        input_placeholder:
          type: string
          description: Placeholder text for the message input
          example: Ask me anything...
        greeting_text:
          type: string
          description: Greeting text shown as a tooltip near the chat bubble
          example: Hi! Need help?
        show_branding:
          type: boolean
          description: Show "Powered by ClearTalk" branding in chat footer
          example: true
        bubble_icon_image:
          type: string
          description: Custom bubble icon image path (uploaded file)
        input_bg_color:
          type: string
          description: Input text box background color (hex)
          example: '#f0f0f0'
        persistent_buttons:
          description: Persistent action buttons shown at bottom of chat widget (max 4)
          example:
            - label: Schedule Call
              icon: phone
              action_type: url
              action_value: https://calendly.com/demo
          type: array
          items:
            type: string
      required:
        - chatbotName
        - chatbot_title
        - header_color
        - background_color
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key for authentication

````