Web chat · Configure the website bot
Everything a customer sets after publishing: which sites may embed it, how it looks, what it asks a visitor for, whether it can fetch a colleague, and what it may spend in a month.
appearance, lead_form and handover are replaced wholesale, and
allowed_origins is the whole list. Sending {"appearance": {"title": "x"}}
discards every other appearance field. Read the bot first and send the
complete object, including the parts that are not changing.
status is the live toggle — paused is how a bot stops answering without
the customer taking the snippet off their page, and is the reversible way to
unpublish. Switching to active also takes a draft agent live, because a
draft agent cannot run and the widget would otherwise report success and stay
silent.
The response’s lead_form_policy and lead_form_fields are resolved from
what was stored, so read them back rather than assuming the write echoes.
Authentication
Header authentication of the form Api-Key <token>
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Agent UUID or slug — both are accepted. From agents_listAgents.
Request
The live toggle. paused stops the bot answering while the snippet stays on the customer’s page; active also takes a draft agent live.
Sites permitted to embed the widget, as origins (https://shop.example). The whole list — to add one, send the existing entries alongside it. Empty allows any site that has the key. A browser-side check, not a spend control: the monthly cap is what bounds cost.
Messages this bot may answer per calendar month. null is no cap; 0 answers nobody. Counted in messages, not credits.