Skip to main content
PUT
Update the widget configuration of a website channel

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Yol Parametreleri

id
integer
gerekli

The channel identifier

Gövde

application/json

Mirrors the field set of the Filament "Widget Ayarları" page. Every key is optional so a client can patch a single colour without resending the whole theme; omitted keys keep their stored value.

primary_color
string | null

The main brand colour of the widget.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
secondary_color
string | null

The secondary colour used in the header gradient.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
background_color
string | null

The background colour of the widget panel.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
border_radius
integer

The corner radius of the widget panel in pixels.

Gerekli aralık: 0 <= x <= 50
shadow
enum<string>

The drop shadow of the widget panel (none, small, medium, large).

Mevcut seçenekler:
none,
small,
medium,
large
title
string

The title shown in the widget header.

Maximum string length: 100
header_bg_color
string | null

The background colour of the header.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
header_text_color
string | null

The text colour of the header.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
header_padding
integer

The inner spacing of the header in pixels.

Gerekli aralık: 4 <= x <= 40
show_header_gradient
boolean

Whether the header is filled with a gradient.

welcome_message
string

The greeting shown before the visitor writes anything.

Maximum string length: 500
auto_open_delay
integer | null

Seconds before the widget opens itself. Send null to disable auto-open.

Gerekli aralık: 1 <= x <= 60
allow_message_editing
boolean

Whether authorized staff can edit outbound website text messages.

allow_message_deletion
boolean

Whether authorized staff can delete outbound website messages and attachments.

font_family
enum<string>

The font family slug used by the widget.

Mevcut seçenekler:
system,
inter,
roboto,
open-sans,
nunito,
lato,
poppins,
montserrat,
raleway,
dm-sans,
plus-jakarta-sans,
manrope,
outfit,
work-sans,
source-sans-3,
rubik,
figtree,
ubuntu,
playfair-display,
merriweather,
lora,
pt-serif,
noto-serif,
libre-baskerville,
fira-code,
jetbrains-mono,
source-code-pro,
bebas-neue,
righteous,
space-grotesk
base_font_size
integer

The base font size in pixels.

Gerekli aralık: 8 <= x <= 72
header_font_size
integer

The header font size in pixels.

Gerekli aralık: 8 <= x <= 72
message_font_size
integer

The message font size in pixels.

Gerekli aralık: 8 <= x <= 72
header_font_weight
integer

The header font weight.

Gerekli aralık: 100 <= x <= 900
message_font_weight
integer

The message font weight.

Gerekli aralık: 100 <= x <= 900
send_button_font_weight
integer

The send button font weight.

Gerekli aralık: 100 <= x <= 900
user_msg_bg_color
string | null

The background colour of the visitor's own messages.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
user_msg_text_color
string | null

The text colour of the visitor's own messages.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
agent_msg_bg_color
string | null

The background colour of the assistant's messages.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
agent_msg_text_color
string | null

The text colour of the assistant's messages.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
message_border_radius
integer

The corner radius of message bubbles in pixels.

Gerekli aralık: 0 <= x <= 40
message_padding
integer

The inner spacing of message bubbles in pixels.

Gerekli aralık: 4 <= x <= 32
message_spacing
integer

The vertical gap between messages in pixels.

Gerekli aralık: 0 <= x <= 32
input_placeholder
string

The placeholder text of the message input.

Maximum string length: 100
input_bg_color
string | null

The background colour of the message input.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
input_text_color
string | null

The text colour of the message input.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
input_border_color
string | null

The border colour of the message input.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
input_border_radius
integer

The corner radius of the message input in pixels.

Gerekli aralık: 0 <= x <= 30
send_button_color
string | null

The background colour of the send button.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
send_button_icon_color
string | null

The icon colour of the send button.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
bubble_icon
enum<string>

The icon shown on the floating button (chat, headset, help, wave).

Mevcut seçenekler:
chat,
headset,
help,
wave
fab_size
integer

The diameter of the floating button in pixels.

Gerekli aralık: 40 <= x <= 80
fab_bg_color
string | null

The background colour of the floating button.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
fab_icon_color
string | null

The icon colour of the floating button.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
fab_border_radius
integer

The corner radius of the floating button in pixels.

Gerekli aralık: 0 <= x <= 9999
fab_shadow
enum<string>

The drop shadow of the floating button (none, small, medium, large).

Mevcut seçenekler:
none,
small,
medium,
large
fab_pulse_animation
boolean

Whether the floating button pulses to draw attention.

position
enum<string>

The corner the widget sits in (bottom-right, bottom-left).

Mevcut seçenekler:
bottom-right,
bottom-left
position_bottom
integer

The gap from the bottom of the page in pixels.

Gerekli aralık: 0 <= x <= 100
position_side
integer

The gap from the side of the page in pixels.

Gerekli aralık: 0 <= x <= 100
widget_width
integer

The width of the widget panel in pixels.

Gerekli aralık: 280 <= x <= 500
widget_height
integer

The height of the widget panel in pixels.

Gerekli aralık: 400 <= x <= 800
custom_css
string | null

Extra CSS injected into the widget.

Maximum string length: 10000

Yanıt

The response is of type object.