Update widget appearance
update_widget_appearanceSet how a website inbox's chat widget looks and behaves: colours, light/dark theme, header style, the screen it opens on, per-language greetings and launcher text, launcher side/icon/offsets (the custom icon needs an image uploaded in the Widget Builder first), the launcher style (bubble, or a minimized text card with a prompt line, a button label per language and an optional https link under it, collapsed to the bubble on mobile unless launcher_card_on_mobile), the launcher_shape (round bubble or labelled pill), the bubble_theme (app, bocadillo, soft_brutal or echo: restyles the launcher, chat panel and text card together), the cards shown over the closed launcher (greeting with a text per language, away, typing, quick replies), the help-center deflection mode, whether "Powered by HellouOne" shows, under the text card too (hiding it needs a plan that allows it), and which sites may embed it. Buttons follow brand_color unless the widget has an action_color of its own. Installed widgets pick the change up on their next page load. Only the fields passed change; get_inbox shows the current values.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"inbox_id": "<inbox_id>"
},
"name": "update_widget_appearance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| theme | No | ||
| inbox_id | Yes | ||
| greetings | No | Language code => {title, tagline}; replaces all greetings. | |
| deflection | No | ||
| brand_color | No | ||
| action_color | No | ||
| bubble_theme | No | app is the current look. bocadillo gives every shape one square corner; soft_brutal is ink outlines with hard shadows; echo adds a faint offset copy behind each shape. | |
| header_style | No | ||
| start_screen | No | ||
| launcher_icon | No | hellou is the default mark. The *_animated icons, typing, duo, wave, heart, cursor and face are animated (still for visitors who reduce motion). custom draws the image an administrator uploaded in the Widget Builder first; it cannot be set before that upload. | |
| show_branding | No | ||
| launcher_label | No | Language code => launcher text; {} for icon only. | |
| launcher_pulse | No | ||
| launcher_shape | No | bubble is the round button; pill is icon plus label, 48px tall (always shown, phones included). | |
| launcher_style | No | bubble is the round button; card is a minimized text card with a prompt line and a button. | |
| allowed_domains | No | Sites allowed to embed the widget, one per line (example.com, *.example.com); null lets any site embed it. | |
| away_card_enabled | No | Outside business hours, show when the team is back and where the reply arrives (needs business hours on the inbox). Off by default. | |
| launcher_card_cta | No | Language code => card button label (24 characters at most); replaces all languages. | |
| launcher_position | No | ||
| greeting_card_text | No | Language code => greeting text (120 characters at most); replaces all languages. Empty: the widget's own hello. | |
| launcher_card_text | No | Language code => card prompt line (60 characters at most); replaces all languages. | |
| typing_card_enabled | No | Show who is typing over the closed launcher. Off by default. | |
| greeting_card_enabled | No | Show a hello over the closed launcher 8 seconds after the page loads, to visitors with no conversation. Off by default. | |
| launcher_card_link_url | No | https:// address the card link opens in a new tab (500 characters at most); null removes the link. | |
| launcher_card_on_mobile | No | false (default): on small screens the card collapses to the bubble. | |
| launcher_card_link_label | No | Language code => label of the optional link under the card (30 characters at most); replaces all languages. Shown only together with launcher_card_link_url. | |
| quick_replies_card_enabled | No | Show an AI agent's question with up to three answers over the closed launcher; an answer opens the chat. Off by default. |