widgets_update
Update an existing livechat widget configuration.
You can change name, theme, auto-reply mode, and other settings. Only provided fields will be updated.
Use this when user wants to modify their chat widget settings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New name for the widget | |
| position | No | Widget position on screen. OMIT to leave the position unchanged. | |
| is_active | No | Enable or disable the widget. OMIT to leave the active flag unchanged. | |
| widget_id | Yes | ID of the widget to update | |
| allow_voice | No | Master switch for voice on this widget — set true to show the mic and let visitors talk to the agent. Everything else voice-related (greeting, button label, STT/TTS from the agent's own config) is inert until this is on. The mic also needs a voice-capable agent in the workspace: one with an enabled incoming_call trigger. OMIT to leave the setting unchanged. | |
| website_url | No | Website URL for product/site search integration | |
| calendly_url | No | Booking URL for calendar action (e.g., 'https://calendly.com/yourname') | |
| color_scheme | No | Widget color scheme. 'auto' follows the visitor's OS dark/light mode preference. OMIT to leave the color scheme unchanged. | |
| display_mode | No | Visual mode of the widget. Pick exactly one: - 'chat': full chat panel + voice mic — default for support / sales / general. - 'voice_only': mic-only bubble that launches a voice call directly — pick only when the user explicitly asks for a voice-only widget. - 'headless': no UI; customer drives via window.DialogBrain JS API — pick only when the user explicitly says 'embed in our own design'. OMIT to leave the display mode unchanged. | |
| header_title | No | Title shown in chat header | |
| in_workspace | No | Run this one call in this workspace id instead of the session's. Nothing is stored; other sessions are not affected. | |
| greeting_text | No | Custom greeting message shown when visitor opens the chat (e.g., 'Hello! How can I help you today?') | |
| primary_color | No | Primary color for widget theme (hex, e.g., '#2563eb'). Paints the header, the visitor's message bubbles and the send button — and the launcher bubble too unless launcher_color overrides it. | |
| launcher_color | No | Color of the closed launcher bubble ONLY (hex, e.g., '#ffffff'). Use when the site pairs a light button with a dark panel and one colour cannot express both. Pass an empty string to clear it and let the launcher follow primary_color. Text and glyphs pick themselves from the background, so a light value stays readable. | |
| voice_greeting | No | Spoken opening line when a visitor starts a voice call through this widget. Played via TTS before the AI model runs. Empty string disables the greeting. Requires allow_voice=true to be audible. | |
| allowed_domains | No | List of allowed domains for the widget | |
| auto_reply_mode | No | Auto-reply mode: 'draft' or 'auto'. OMIT to leave the auto-reply mode unchanged. | |
| header_subtitle | No | Subtitle shown in chat header | |
| greeting_enabled | No | Enable or disable the proactive greeting. OMIT to leave this flag unchanged. | |
| greeting_behavior | No | notification = show badge after delay; auto_open = open widget automatically after delay; on_open = greet only when visitor manually opens. OMIT to leave the greeting behavior unchanged. | |
| enable_form_action | No | Enable or disable the contact form action button. OMIT to leave this flag unchanged. | |
| voice_button_label | No | Localized aria-label and hover tooltip for the voice-only mic bubble (only used when display_mode='voice_only'). ≤ 100 chars. Defaults to 'Talk to agent' if not set. | |
| contact_form_fields | No | Fields to collect in contact form (e.g., ['name', 'email', 'phone']) | |
| enable_search_action | No | Enable or disable the search action button. OMIT to leave this flag unchanged. | |
| show_visitor_history | No | Show full chat history to returning visitors. OMIT to leave this flag unchanged. | |
| identification_fields | No | Fields to require for visitor identification (e.g., ['name', 'email']) | |
| enable_calendar_action | No | Enable or disable the calendar booking action button. OMIT to leave this flag unchanged. | |
| greeting_delay_seconds | No | Delay in seconds before the proactive greeting appears (0–300). 0 = send immediately on page load. Default: 30. | |
| require_identification | No | Require visitor to identify before chatting. OMIT to leave the identification policy unchanged. | |
| returning_greeting_text | No | Greeting for returning visitors who already have chat history (e.g., 'Welcome back! How can I help you today?'). Falls back to greeting_text if not set. | |
| max_voice_duration_seconds | No | Hard cap on a single voice call from this widget, in seconds (default 300). OMIT to leave the cap unchanged. |