Skip to main content
PATCH
Update widget settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
enabled
boolean
branding_enabled
boolean
icon_visible
boolean
contact_avatars_enabled
boolean
Maximum string length: 255
changelog_enabled
boolean
roadmap_enabled
boolean
support_enabled
boolean
help_center_enabled
boolean
ai_chat_enabled
boolean
live_chat_enabled
boolean
guest_chat_enabled
boolean

When false, only signed-in visitors can start a conversation.

feedback_enabled
boolean
whats_new_enabled
boolean

Response

Successful response

enabled
boolean
required
widget_key
string
required
default_view
string
required
icon_type
string
required
icon_visible
boolean
required
size
string
required
branding_enabled
boolean
required
custom_styling_enabled
boolean
required
contact_avatars_enabled
boolean
required
identity_verification_enabled
boolean
required
portal_auth_enabled
boolean
required
guest_chat_enabled
boolean
required
sections
object
required
updated_at
string
required