Skip to main content
Update Agent Widget
enabled_modes decides whether visitors can type, talk, or both. default_variables supplies values for the agent’s {{variables}} on every conversation the widget starts — a plan name, a page, a customer id your site already knows.

Authorizations

Authorization
string
header
required

Your API key as a Bearer token, e.g. Authorization: Bearer vk_….

Path Parameters

agent_id
string
required

The agent's id, as GET /v1/agents returns it.

Body

application/json
name
string | null

What to call this widget.

Required string length: 1 - 255
allowed_origins
string[] | null

The security boundary: which origins may use this widget's public key. Sending the list replaces the whole set.

enabled_modes
WidgetModes · object | null

Whether visitors can type, talk, or both.

theme
WidgetTheme · object | null

Appearance and placement.

default_variables
Default Variables · object | null

Values supplied for the agent's {{variables}} on every conversation this widget starts.

status
string | null

Whether the widget is live or paused.

Response

The updated widget.

id
string
agent_id
string
name
string
allowed_origins
string[]
enabled_modes
object
theme
object
default_variables
object
public_key_prefix
string
status
string
created_at
string<date-time>
updated_at
string<date-time>